ax(mining): replace Manager prose comment with usage example
Some checks failed
Security Scan / security (push) Successful in 33s
Test / test (push) Has been cancelled

AX Principle 2: comments must show HOW with real values, not restate
what the type signature already says. Replaced the prose description
on Manager with a concrete call sequence.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 10:39:59 +01:00
parent 0ab8c0fe7d
commit 0e31a6e99a
No known key found for this signature in database
GPG key ID: AF404715446AEB41

View file

@ -28,7 +28,9 @@ type ManagerInterface interface {
Stop()
}
// Manager handles the lifecycle and operations of multiple miners.
// manager := mining.NewManager()
// defer manager.Stop()
// miner, err := manager.StartMiner(ctx, "xmrig", &mining.Config{Algo: "rx/0"})
type Manager struct {
miners map[string]Miner
mu sync.RWMutex