ax(mining): replace prose comment on NewTTMiner with usage example
AX Principle 2: comments must show concrete usage, not restate the signature. Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
parent
fd1aed63fe
commit
ceab3960bc
1 changed files with 2 additions and 1 deletions
|
|
@ -54,7 +54,8 @@ type TTMinerSummary struct {
|
|||
// MinerTypeTTMiner is the type identifier for TT-Miner miners.
|
||||
const MinerTypeTTMiner = "tt-miner"
|
||||
|
||||
// NewTTMiner creates a new TT-Miner instance with default settings.
|
||||
// miner := mining.NewTTMiner()
|
||||
// miner.Start(ctx)
|
||||
func NewTTMiner() *TTMiner {
|
||||
return &TTMiner{
|
||||
BaseMiner: BaseMiner{
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue