tasklog/{log,waiting_task}.go: fix code comments

We can update several code comments in the "tasklog" package to
reflect their corresponding functions and fix typos.
This commit is contained in:
Chris Darroch 2023-05-24 16:24:12 -07:00
parent 1efc16b424
commit 46d1a93b22
2 changed files with 4 additions and 4 deletions

@ -115,7 +115,7 @@ func (l *Logger) Close() {
l.wg.Wait()
}
// Waitier creates and enqueues a new *WaitingTask.
// Waiter creates and enqueues a new *WaitingTask.
func (l *Logger) Waiter(msg string) *WaitingTask {
t := NewWaitingTask(msg)
l.Enqueue(t)
@ -139,7 +139,7 @@ func (l *Logger) List(msg string) *ListTask {
return t
}
// List creates and enqueues a new *SimpleTask.
// Simple creates and enqueues a new *SimpleTask.
func (l *Logger) Simple() *SimpleTask {
t := NewSimpleTask()
l.Enqueue(t)

@ -28,8 +28,8 @@ func (w *WaitingTask) Complete() {
close(w.ch)
}
// Done implements Task.Done and returns a channel which is closed when
// Complete() is called.
// Updates implements the Task.Updates function and returns a channel of updates
// to log to the sink.
func (w *WaitingTask) Updates() <-chan *Update {
return w.ch
}