gh-121277: Raise nice error on next as second argument to deprecated-removed
#124623
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
…recated-removed
6 tasks
ezio-melotti
approved these changes
Sep 26, 2024
Comment on lines
+291
to
+293
| if version_removed == 'next': | ||
| raise ValueError( | ||
| 'deprecated-removed:: second argument cannot be `next`') |
There was a problem hiding this comment.
Suggested change
| if version_removed == 'next': | |
| raise ValueError( | |
| 'deprecated-removed:: second argument cannot be `next`') | |
| if version_removed == 'next': | |
| raise ValueError( | |
| 'deprecated-removed:: second argument should be the version in which ' | |
| 'the API will be removed, and cannot be `next`') |
There was a problem hiding this comment.
Thanks for the suggestion! But I do think it's too long, and I hope anyone who adds deprecated-removed:: already knows what the args are. If they need this error to find that out, something's very wrong :)
encukou
added a commit
to encukou/cpython
that referenced
this pull request
Sep 27, 2024
…recated-removed (pythonGH-124623) (cherry-picked from e349f73)
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.
Using
nextas the second argument doesn't make sense, but users should get a nicer message thanValueError: invalid literal for int()-- especially since Sphinx hides the traceback by default... versionadded:: nextin docs #121277📚 Documentation preview 📚: https://cpython-previews--124623.org.readthedocs.build/