From 0e31a6e99ab2168c901fe770cf5e359c00a78c11 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 10:39:59 +0100 Subject: [PATCH] ax(mining): replace Manager prose comment with usage example 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 --- pkg/mining/manager.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg/mining/manager.go b/pkg/mining/manager.go index f4c3eff..bb4ed7f 100644 --- a/pkg/mining/manager.go +++ b/pkg/mining/manager.go @@ -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