From 9447ccbc747abcd58e98136ee346144c1cfbfeca Mon Sep 17 00:00:00 2001 From: Tiago Silva Date: Thu, 9 May 2024 16:22:57 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Matthew Dowdell --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b10917f..b5a4d78 100644 --- a/README.md +++ b/README.md @@ -170,11 +170,11 @@ slog.Info("a user has logged in", ### Arguments with forbidden keys -To ensure users don't use reserved words in key-value pairs, you may want to enforce rules to avoid misusages. +To ensure users don't use reserved words in key-value pairs, you may want to enforce rules to avoid misuse. The `forbidden-key` option causes `sloglint` to report usages of forbidden keys. These keys could be typically controlled by slog handlers and its usage should be preserved to avoid key duplication. ```go -slog.Info("a user has logged in", "reserved_key", 49) // sloglint: keys include forbidden values +slog.Info("a user has logged in", "forbidden_key", 49) // sloglint: "forbidden_key" key is forbidden and should not be used ``` [1]: https://golangci-lint.run