Update README and docs

Author: hermannm

README.md

@@ -1,6 +1,6 @@
 # devlog
 
-A structured logging handler for Go, with a human-readable output format designed for development
+A structured log handler for Go, with a human-readable output format designed for development
 builds.
 
 Run `go get hermannm.dev/devlog` to add it to your project!

buffer.go

@@ -111,7 +111,7 @@ func (buffer byteBuffer) copy() byteBuffer {
 	return newBuffer
 }
 
-// Inspired by Jonathan Amsterdam's guide to writing structured logging handlers:
+// Inspired by Jonathan Amsterdam's guide to writing structured log handlers:
 // https://github.com/golang/example/blob/1d6d2400d4027025cb8edc86a139c9c581d672f7/slog-handler-guide/README.md#speed
 var bufferPool = sync.Pool{
 	New: func() any {

doc.go

@@ -1,5 +1,5 @@
-// Package devlog implements a structured logging (slog) handler, with a human-readable output
-// format designed for development builds.
+// Package devlog implements a structured log (slog) handler, with a human-readable output format
+// designed for development builds.
 //
 // A devlog.Handler can be configured as follows:
 //

handler_test.go

@@ -13,7 +13,7 @@ import (
 	"hermannm.dev/devlog"
 )
 
-// Tests our handler against the standard library test suite for structured logging handlers.
+// Tests our handler against the standard library test suite for structured log handlers.
 func TestSlog(t *testing.T) {
 	var buffer bytes.Buffer
 
@@ -199,7 +199,7 @@ want:
 	}
 }
 
-// slogtest.Run requires us to parse our logging output to a map[string]any.
+// slogtest.Run requires us to parse our log output to a map[string]any.
 func parseLogEntry(entryString string) (map[string]any, error) {
 	entry := make(map[string]any)
 

log/log.go

@@ -210,7 +210,7 @@ func WarnErrors(message string, errs ...error) {
 // Debug logs the given message at the DEBUG log level, along with any given log attributes.
 // It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -233,7 +233,7 @@ func Debug(message string, logAttributes ...any) {
 // Debugf creates a message from the given format and arguments using [fmt.Sprintf], and logs it at
 // the DEBUG log level. It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func Debugf(messageFormat string, formatArgs ...any) {
 	if logger, enabled := defaultLogger(slog.LevelDebug); enabled {
@@ -244,7 +244,7 @@ func Debugf(messageFormat string, formatArgs ...any) {
 // DebugError logs the given error at the DEBUG log level, along with any given log attributes.
 // It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -267,7 +267,7 @@ func DebugError(err error, logAttributes ...any) {
 // DebugErrorCause logs the given message at the DEBUG log level, and adds a 'cause' attribute with
 // the given error, along with any other log attributes. It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -290,7 +290,7 @@ func DebugErrorCause(err error, message string, logAttributes ...any) {
 // DebugErrorCausef logs a formatted message (using [fmt.Sprintf]) at the DEBUG log level, and adds
 // a 'cause' attribute with the given error. It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func DebugErrorCausef(err error, messageFormat string, formatArgs ...any) {
 	if logger, enabled := defaultLogger(slog.LevelDebug); enabled {
@@ -301,7 +301,7 @@ func DebugErrorCausef(err error, messageFormat string, formatArgs ...any) {
 // DebugErrors logs the given message at the DEBUG log level, and adds a 'cause' attribute with the
 // given errors. It uses the [slog.Default] logger.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func DebugErrors(message string, errs ...error) {
 	if logger, enabled := defaultLogger(slog.LevelDebug); enabled {
@@ -560,7 +560,7 @@ func (logger Logger) WarnErrors(message string, errs ...error) {
 
 // Debug logs the given message at the DEBUG log level, along with any given log attributes.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -583,7 +583,7 @@ func (logger Logger) Debug(message string, logAttributes ...any) {
 // Debugf creates a message from the given format and arguments using [fmt.Sprintf], and logs it at
 // the DEBUG log level.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func (logger Logger) Debugf(messageFormat string, formatArgs ...any) {
 	if level, enabled := logger.withLevel(slog.LevelDebug); enabled {
@@ -593,7 +593,7 @@ func (logger Logger) Debugf(messageFormat string, formatArgs ...any) {
 
 // DebugError logs the given error at the DEBUG log level, along with any given log attributes.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -616,7 +616,7 @@ func (logger Logger) DebugError(err error, logAttributes ...any) {
 // DebugErrorCause logs the given message at the DEBUG log level, and adds a 'cause' attribute with
 // the given error, along with any other log attributes.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 //
 // # Log attributes
@@ -639,7 +639,7 @@ func (logger Logger) DebugErrorCause(err error, message string, logAttributes ..
 // DebugErrorCausef logs a formatted message (using [fmt.Sprintf]) at the DEBUG log level, and adds
 // a 'cause' attribute with the given error.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func (logger Logger) DebugErrorCausef(err error, messageFormat string, formatArgs ...any) {
 	if level, enabled := logger.withLevel(slog.LevelDebug); enabled {
@@ -650,7 +650,7 @@ func (logger Logger) DebugErrorCausef(err error, messageFormat string, formatArg
 // DebugErrors logs the given message at the DEBUG log level, and adds a 'cause' attribute with the
 // given errors.
 //
-// Note that the DEBUG log level is typically disabled by default in most slog handlers, in which
+// Note that the DEBUG log level is typically disabled by default in most log handlers, in which
 // case no output will be produced.
 func (logger Logger) DebugErrors(message string, errs ...error) {
 	if level, enabled := logger.withLevel(slog.LevelDebug); enabled {