From 7b098da3bef3ff024f49badea2d2a2f24c066808 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 16:56:59 +0100 Subject: [PATCH] ax(mining): replace prose comments with usage examples in simulated_miner.go MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit AX principle 2 — comments must show HOW (concrete call), not restate WHAT the name already says. Three prose-style descriptions replaced with realistic usage examples showing struct construction and registration. Co-Authored-By: Charon --- pkg/mining/simulated_miner.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/mining/simulated_miner.go b/pkg/mining/simulated_miner.go index 0374afa..fe6f588 100644 --- a/pkg/mining/simulated_miner.go +++ b/pkg/mining/simulated_miner.go @@ -9,10 +9,10 @@ import ( "time" ) -// MinerTypeSimulated is the type identifier for simulated miners. +// factory.Register(MinerTypeSimulated, func() Miner { return NewSimulatedMiner(SimulatedMinerConfig{}) }) const MinerTypeSimulated = "simulated" -// SimulatedMiner is a mock miner that generates realistic-looking stats for UI testing. +// miner := &SimulatedMiner{Name: "sim-001", MinerType: MinerTypeSimulated, Algorithm: "rx/0"} type SimulatedMiner struct { // Exported fields for JSON serialization Name string `json:"name"` @@ -42,7 +42,7 @@ type SimulatedMiner struct { difficultyBase int } -// SimulatedMinerConfig holds configuration for creating a simulated miner. +// SimulatedMinerConfig{Name: "sim-001", Algorithm: "rx/0", BaseHashrate: 5000, Variance: 0.1} type SimulatedMinerConfig struct { Name string // Miner instance name (e.g., "sim-xmrig-001") Algorithm string // Algorithm name (e.g., "rx/0", "kawpow", "ethash")