Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ax(mining): remove prose comment that restates the ErrCircuitOpen declaration

Browse source 
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 <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 12:30:31 +01:00
parent c20670f062
commit e656a12da7
No known key found for this signature in database
GPG key ID: AF404715446AEB41
1 changed files with 0 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
pkg/mining/circuit_breaker.go
View file

@ -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")