Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.1k
gh-121277: Raise nice error onnext as second argument to deprecated-removed#124623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
6 tasks
ezio-melotti approved these changesSep 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I left a suggestion in case you want to be more explicit, but otherwise your version works too.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Suggested change
| ifversion_removed=='next': | |
| raiseValueError( | |
| 'deprecated-removed:: second argument cannot be `next`') | |
| ifversion_removed=='next': | |
| raiseValueError( | |
| '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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for the suggestion! But I do think it's too long, and I hope anyone who addsdeprecated-removed:: already knows what the args are. If they need this error to find that out, something's very wrong :)
e349f73 intopython:main 28 checks passed
Uh oh!
There was an error while loading.Please reload this page.
encukou added a commit to encukou/cpython that referenced this pull requestSep 27, 2024
…recated-removed (pythonGH-124623)(cherry-picked frome349f73)
encukou added a commit that referenced this pull requestOct 25, 2024
…124718)*gh-121277: Allow `.. versionadded:: next` in docs (GH-121278)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)*gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)(cherry-picked frome349f73)
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestOct 25, 2024
…nGH-121278) (pythonGH-124718)*pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)*pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623)(cherry-picked frome349f73)(cherry picked from commitdba992b)Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit that referenced this pull requestOct 28, 2024
…H-125980)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)(cherry picked from commit7d24ea9)Also backports a minor fix-up:gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)(cherry-picked from commite349f73)Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit to encukou/cpython that referenced this pull requestDec 11, 2024
…nGH-121278) (python#124718)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623)(cherry-picked frome349f73)
pablogsal pushed a commit that referenced this pull requestDec 11, 2024
…124718) (#127827)* [3.11]gh-121277: Allow `.. versionadded:: next` in docs (GH-121278) (#124718)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)(cherry-picked frome349f73)* Import VersionChangesphinx.domains.changeset.VersionChange exists at least since Sphinx 2.1,according to:https://www.sphinx-doc.org/en/master/extdev/deprecated.html* Get config from env* Use version, not arguments directly
encukou added a commit to encukou/cpython that referenced this pull requestDec 12, 2024
…H-121278)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623)(cherry-picked frome349f73)Updates for 3.10(cherry-picked from 3.11:f0895aa)* Use version, not arguments directly
encukou added a commit to encukou/cpython that referenced this pull requestDec 12, 2024
…H-121278)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623)(cherry-picked frome349f73)Updates for 3.10(cherry-picked from 3.11:f0895aa)* Use version, not arguments directly
pablogsal pushed a commit that referenced this pull requestDec 13, 2024
…127867)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)(cherry-picked frome349f73)Updates for 3.10(cherry-picked from 3.11:f0895aa)* Use version, not arguments directly
encukou added a commit to encukou/cpython that referenced this pull requestDec 20, 2024
…-121278) (pythonGH-127867)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623)(cherry-picked frome349f73)Updates for 3.9(cherry-picked from 3.11:f0895aa)(cherry-picked from 3.10:8773554)* Use version, not arguments directly
ambv pushed a commit that referenced this pull requestJan 23, 2025
…28117)Make `versionchanged:: next`` expand to current (unreleased) version.When a new CPython release is cut, the release manager will replaceall such occurences of "next" with the just-released version.(See the issue for release-tools and devguide PRs.)Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>(cherry picked from commit7d24ea9)gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)(cherry-picked frome349f73)(cherry-picked from 3.11:f0895aa)(cherry-picked from 3.10:8773554)
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
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/