Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/pkg/mining
History
Claude 0d1b20e177
ax(batch): replace prose comments with usage examples across all packages 
Applies AX principle 2 (Comments as Usage Examples) — removes prose
descriptions that restate the function signature ("returns", "retrieves",
"creates", "wraps", etc.) and keeps or replaces with concrete usage
examples showing real calls with realistic values.

Co-Authored-By: Charon <charon@lethean.io>
2026-04-02 18:28:16 +01:00
..
component feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
auth.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
auth_test.go ax(mining): rename cfg to authConfig in auth_test.go 2026-04-02 13:05:33 +01:00
bufpool.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
circuit_breaker.go ax(mining): rename cb receiver to circuitBreaker in CircuitBreaker methods 2026-04-02 17:37:00 +01:00
circuit_breaker_test.go ax(batch): expand abbreviated local variable names across all packages 2026-04-02 18:15:15 +01:00
component.go ax(mining): replace prose comment with usage example on GetComponentFS 2026-04-02 10:07:18 +01:00
config_manager.go ax(mining): remove banned fmt import from config_manager.go 2026-04-02 16:04:52 +01:00
container.go ax(mining): replace prose field comments with usage examples in ContainerConfig 2026-04-02 16:47:16 +01:00
container_test.go ax(batch): apply Good/Bad/Ugly test naming convention across all packages 2026-04-02 18:20:32 +01:00
dual_mining_test.go ax(mining): fix test naming and comment style in dual_mining_test.go 2026-04-02 16:13:48 +01:00
errors.go ax(batch): remove banned import references from comment examples 2026-04-02 18:07:35 +01:00
errors_test.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:16:56 +01:00
events.go ax(mining): rename msg to clientMessage in wsClient.readPump 2026-04-02 17:55:41 +01:00
events_test.go ax(batch): apply Good/Bad/Ugly test naming convention across all packages 2026-04-02 18:20:32 +01:00
file_utils.go ax(mining): remove banned fmt import from file_utils.go 2026-04-02 16:04:07 +01:00
lethean.go ax(mining): remove prose comment that restates constant name 2026-04-02 16:44:39 +01:00
lethean_test.go feat(mining): add Lethean pool presets + ProgPoWZ profiles 2026-04-02 07:22:48 +01:00
manager.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:28:16 +01:00
manager_interface.go feat: Enhance mining configuration management and API documentation 2025-12-07 16:26:18 +00:00
manager_race_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00
manager_test.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:16:56 +01:00
metrics.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
miner.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:28:16 +01:00
miner_factory.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
miner_factory_test.go refactor: Add MinerFactory to centralize miner instantiation 2025-12-31 11:12:33 +00:00
mining.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
mining_profile.go ax(mining): replace prose type comments with usage examples in mining_profile.go 2026-04-02 13:15:17 +01:00
mining_test.go ax(mining): rename mining_test.go functions to TestFilename_Function_{Good,Bad,Ugly} convention 2026-04-02 11:49:07 +01:00
node_service.go ax(mining): remove ErrCodeInternal alias in favour of canonical ErrCodeInternalError 2026-04-02 17:52:03 +01:00
profile_manager.go ax(mining): replace banned fmt.Errorf with project-native error constructors in profile_manager 2026-04-02 16:17:33 +01:00
profile_manager_test.go ax(batch): apply Good/Bad/Ugly test naming convention across all packages 2026-04-02 18:20:32 +01:00
ratelimiter.go ax(mining): rename rl receiver to limiter in RateLimiter methods 2026-04-02 17:23:02 +01:00
ratelimiter_test.go ax(batch): expand abbreviated local variable names across all packages 2026-04-02 18:15:15 +01:00
repository.go ax(batch): expand abbreviated receiver names (AX Principle 1) 2026-04-02 18:05:42 +01:00
repository_test.go test: Add error path unit tests for context cancellation and cleanup 2025-12-31 13:04:20 +00:00
service.go ax(batch): remove banned fmt import from all non-test source files 2026-04-02 18:00:44 +01:00
service_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00
settings_manager.go ax(mining): remove banned fmt import from settings_manager.go 2026-04-02 16:05:34 +01:00
settings_manager_test.go ax(batch): expand abbreviated local variable names across all packages 2026-04-02 18:15:15 +01:00
simulated_miner.go ax(mining): replace prose comments with usage examples in simulated_miner.go 2026-04-02 16:56:59 +01:00
stats_collector.go ax(mining): remove banned encoding/json import from stats_collector.go 2026-04-02 17:20:57 +01:00
stats_collector_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00
supervisor.go ax(mining): rename abbreviated parameter st to supervisedTask in startTask 2026-04-02 17:15:01 +01:00
syslog_unix.go ax(batch): remaining prose-to-example comment conversions 2026-04-02 18:08:24 +01:00
syslog_windows.go ax(batch): replace prose comments with usage examples (AX Principle 2) 2026-04-02 18:03:43 +01:00
throttle_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00
ttminer.go ax(batch): remove banned import references from comment examples 2026-04-02 18:07:35 +01:00
ttminer_start.go ax(batch): remaining prose-to-example comment conversions 2026-04-02 18:08:24 +01:00
ttminer_stats.go ax(mining): replace prose comment with usage example on TTMiner.GetStats 2026-04-02 17:07:57 +01:00
version.go ax(mining): replace encoding/json with internal UnmarshalJSON in version.go 2026-04-02 17:07:00 +01:00
xmrig.go ax(batch): remove banned import references from comment examples 2026-04-02 18:07:35 +01:00
xmrig_gpu_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00
xmrig_start.go ax(batch): remove banned import references from comment examples 2026-04-02 18:07:35 +01:00
xmrig_stats.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:28:16 +01:00
xmrig_test.go ax(batch): apply Good/Bad/Ugly test naming to remaining test files 2026-04-02 18:23:59 +01:00