[B028-doc-update] Update documentation for B028 #14338
Open
+5
−4
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
|
njhearp
changed the title
dylwil3
requested changes
Nov 14, 2024
| /// It's recommended to use a `stacklevel` of 2 or higher, give the caller | ||
| /// more context about the warning. | ||
| /// It's recommended to use a `stacklevel` of 2 or higher, to give the caller | ||
| /// a more appropriate context about the warning. |
There was a problem hiding this comment.
Actually I think this line with just "more context about the warning" sounds better as is. (But the "give"--> "to give" looks good)
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.
Summary
Resolves #14289
The documentation for B028 no_explicit_stacklevel is updated to be more clear.