From e656a12da776cf4031567c7c1c30feedc78cd903 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 2 Apr 2026 12:30:31 +0100 Subject: [PATCH] ax(mining): remove prose comment that restates the ErrCircuitOpen declaration AX Principle 2: comments must show usage examples, not restate what the type signature already says. The line "ErrCircuitOpen is returned when the circuit is open" adds zero information over the var declaration itself. The usage example below it is kept. Co-Authored-By: Charon --- pkg/mining/circuit_breaker.go | 1 - 1 file changed, 1 deletion(-) diff --git a/pkg/mining/circuit_breaker.go b/pkg/mining/circuit_breaker.go index 4716105..a0f90af 100644 --- a/pkg/mining/circuit_breaker.go +++ b/pkg/mining/circuit_breaker.go @@ -64,7 +64,6 @@ type CircuitBreaker struct { cacheDuration time.Duration } -// ErrCircuitOpen is returned when the circuit is open // if err == ErrCircuitOpen { /* fallback to cached result */ } var ErrCircuitOpen = NewMiningError(ErrCodeServiceUnavailable, "circuit breaker is open")