ax(mining): replace prose comment with usage example on XMRigMiner
Some checks are pending
Security Scan / security (push) Waiting to run
Test / test (push) Waiting to run

AX principle 2: comments show HOW with real values, not WHAT the type is.
The old comment restated the struct definition. Replaced with a concrete
construction example.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 17:08:47 +01:00
parent bc7b752754
commit ec0ab317ea
No known key found for this signature in database
GPG key ID: AF404715446AEB41

View file

@ -15,7 +15,9 @@ import (
"github.com/adrg/xdg"
)
// XMRigMiner represents an XMRig miner, embedding the BaseMiner for common functionality.
// miner := &XMRigMiner{}
// miner.Name = "xmrig"
// miner.BinaryPath = "/usr/local/bin/xmrig"
type XMRigMiner struct {
BaseMiner
FullStats *XMRigSummary `json:"-"` // Excluded from JSON to prevent race during marshaling