Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.2k
[3.11] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#124718)#127827
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
…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)
sphinx.domains.changeset.VersionChange exists at least since Sphinx 2.1,according to:https://www.sphinx-doc.org/en/master/extdev/deprecated.html
6 tasks
pablogsal approved these changesDec 11, 2024
I'm happy to get this in yeah :) |
f0895aa intopython:3.11 23 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Thanks@encukou for the PR, and@pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10. |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
3 participants
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.
Make
versionchanged:: nextexpand to current (unreleased) version.When a new CPython release is cut, the release manager will replace
all such occurences of "next" with the just-released version.
(See the issue for release-tools and devguide PRs.)
Obviously, this is not a security fix. It's an internal feature meant to make backporting easier.
@pablogsal, do you want this in 3.11?
The cherry-pick had conflicts that needed some rework.
I tested locally by adding this to docs:
With Sphinx 7.3.7:
With Sphinx 4.2.0 & other old reqs pinned inhttps://github.com/python/cpython/blob/3.11/Doc/requirements-oldest-sphinx.txt:
Co-authored-by: Adam Turner9087854+AA-Turner@users.noreply.github.com
Co-authored-by: Hugo van Kemenade1324225+hugovk@users.noreply.github.com
(cherry picked from commit7d24ea9)
Also backports follow-upGH-124623: Raise nice error on
nextas second argument to deprecated-removed(cherry-picked frome349f73)
.. versionadded:: nextin docs #121277📚 Documentation preview 📚:https://cpython-previews--127827.org.readthedocs.build/