Rename WithTags, clarify docs #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This renames the WithTags method to WithValues, and removes the use of the term "tag" from the documentation. It's replaced with the phrase "named values", and noted that "key" is used to refer to the name of a particular value.
This notes that certain keys (e.g. "error" or "msg") are often used by implementations to attach other information, and thus should generally not be used.
Some underlying implementations attach special meaning to negative log levels (e.g. Zap, where those become positive log levels, which eventually indicate special behavior), so we forbid them.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This renames
WithTagstoWithValues(as per #1 (comment)), and removes the "tag" terminologyfrom the docs, in favor of "named values", with "key" referring to the name
of a value.
It also adds a note suggesting that certain keys (e.g. "error" or "msg") should be
avoided, and clarifies that negative log levels are forbidden.