ax(mining): replace prose comment with usage example on LogBuffer.Clear
AX Principle 2: comments must show usage, not restate the signature. "Clear clears the log buffer." adds zero information beyond the name. Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
parent
58e1c23f0c
commit
ed76d53b85
1 changed files with 1 additions and 1 deletions
|
|
@ -84,7 +84,7 @@ func (lb *LogBuffer) GetLines() []string {
|
|||
return result
|
||||
}
|
||||
|
||||
// Clear clears the log buffer.
|
||||
// lb.Clear() // called on miner Stop() to release memory
|
||||
func (lb *LogBuffer) Clear() {
|
||||
lb.mu.Lock()
|
||||
defer lb.mu.Unlock()
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue