Skip to content

Commit

Permalink
Fix comments on optional sink interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
thockin committed Nov 20, 2022
1 parent a8aea2e commit 5b49379
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions logr.go
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ type LogSink interface {
WithName(name string) LogSink
}

// CallDepthLogSink represents a Logger that knows how to climb the call stack
// CallDepthLogSink represents a LogSink that knows how to climb the call stack
// to identify the original call site and can offset the depth by a specified
// number of frames. This is useful for users who have helper functions
// between the "real" call site and the actual calls to Logger methods.
Expand All @@ -492,7 +492,7 @@ type CallDepthLogSink interface {
WithCallDepth(depth int) LogSink
}

// CallStackHelperLogSink represents a Logger that knows how to climb
// CallStackHelperLogSink represents a LogSink that knows how to climb
// the call stack to identify the original call site and can skip
// intermediate helper functions if they mark themselves as
// helper. Go's testing package uses that approach.
Expand Down

0 comments on commit 5b49379

Please sign in to comment.