Minor improvement to godoc

2023-07-16 22:50:59 -03:00 · 2023-07-16 22:50:59 -03:00 · 9a065de4a5
parent 8d57a16f9c
commit 9a065de4a5
1 changed files with 3 additions and 0 deletions
--- a/logger.go
+++ b/logger.go
@ -82,8 +82,11 @@ type loggerFn func(ctx context.Context, query string, params []interface{}, err
 //
 // Example Usage:
 //
+//     // After injecting a logger into `ctx` all subsequent queries
+//     // that use this context will be logged.
 //     ctx = ksql.InjectLogger(ctx, ksql.Logger)
 //
+//     // All the calls below will cause KSQL to log the queries:
 //     var user User
 //     db.Insert(ctx, usersTable, &user)
 //