CLN: Replace confusing brackets with backticks #54091
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
There are some errors which read like: > only list-like objects are allowed to be passed to isin(), you > passed a [str] (note how the type `str` is enclosed in square brackets) This is potentially confusing, since some languages use notation like `[TYPE]` to denote a list of TYPE objects. So the user could read the error message saying they can't use `[str]`, but intepret `[str]` to mean "a list of str objects". This commit removes the possibility of confusion by using backticks instead of square brackets.
beyarkay
changed the title
mroeschke
approved these changes
Jul 12, 2023
|
Thanks @beyarkay |
|
Thanks for the review! |
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.
There are some errors which read like:
(note how the type
stris enclosed in square brackets)This is potentially confusing, since some languages use notation like
[TYPE]to denote a list of TYPE objects. So the user could read the error message saying they can't use[str], but intepret[str]to mean "a list of str objects".This commit removes the possibility of confusion by using backticks instead of square brackets.