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

AX Principle 2: comments that restate the type signature add zero
information. Replaced with a concrete call site showing how to
obtain and inspect the struct.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 14:36:49 +01:00
parent 22c52c0b70
commit 67ecffed94
No known key found for this signature in database
GPG key ID: AF404715446AEB41

View file

@ -45,7 +45,8 @@ type Miner interface {
WriteStdin(input string) error
}
// InstallationDetails contains information about an installed miner.
// details, err := miner.CheckInstallation()
// if details.IsInstalled { fmt.Println(details.Version, details.Path) }
type InstallationDetails struct {
IsInstalled bool `json:"is_installed"`
Version string `json:"version"`