Skip to content

Commit

Permalink
update comment on Scanner to be general re: structured logs
Browse files Browse the repository at this point in the history
The comment referred only to logfmt but with support for more structured
log formats the comment should be updated as well.
  • Loading branch information
daveworth authored and Antoine Grondin committed Feb 6, 2021
1 parent 34ec2e8 commit 38b15d0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions scanner.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ var (
eol = [...]byte{'\n'}
)

// Scanner reads logfmt'd lines from src and prettify them onto dst.
// If the lines aren't logfmt, it will simply write them out with no
// Scanner reads JSON-structured lines from src and prettify them onto dst. If
// the lines aren't JSON-structured, it will simply write them out with no
// prettification.
func Scanner(src io.Reader, dst io.Writer, opts *HandlerOptions) error {
in := bufio.NewScanner(src)
Expand Down

0 comments on commit 38b15d0

Please sign in to comment.