Skip to content

Commit 2a39053

Browse files
committed
feat: add additional documentation
1 parent eca3e6a commit 2a39053

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

debugo.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ type Debugger struct {
2727
mutex *sync.Mutex
2828
}
2929

30+
// New creates a new debugger instance
3031
func New(namespace string) *Debugger {
3132
return newDebugger(namespace)
3233
}

write.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ type asJSON struct {
1515
ElapsedMs int64 `json:"elapsed_ms,omitempty"`
1616
}
1717

18+
// Debug logs a message if the debuggers namespace matches
1819
func (d *Debugger) Debug(message ...any) *Debugger {
1920
d.write(message...)
2021
return d
2122
}
2223

24+
// Debugf logs a formatted message if the debuggers namespace matches
2325
func (d *Debugger) Debugf(format string, message ...any) *Debugger {
2426
d.write(fmt.Sprintf(format, message...))
2527
return d

0 commit comments

Comments
 (0)