Improve logger documentation#177
Open
naterarmstrong wants to merge 1 commit intoinconshreveable:masterfrom
Open
Improve logger documentation#177naterarmstrong wants to merge 1 commit intoinconshreveable:masterfrom
naterarmstrong wants to merge 1 commit intoinconshreveable:masterfrom
Conversation
Improve logger docs by adding usage examples to some of the commonly used methods that are unclear from function signature alone.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
A super small change to improve development ergonomics. Whenever I use the logger, I end up needing to reference the godoc to remember the exact syntax, as it is not evident from the function signature. By making these changes, the IDE tooltip now looks like the below. The comments are added onto each individual method so that all of them now have the helpful IDE tooltips.