From 67ecffed943321a53711cfd37133826c8172a4fa Mon Sep 17 00:00:00 2001
From: Claude <developers@lethean.io>
Date: Thu, 2 Apr 2026 14:36:49 +0100
Subject: [PATCH] ax(mining): replace prose comment with usage example on
 InstallationDetails

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>
---
 pkg/mining/mining.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/pkg/mining/mining.go b/pkg/mining/mining.go
index f75815a..f9deda8 100644
--- a/pkg/mining/mining.go
+++ b/pkg/mining/mining.go
@@ -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"`