[3.11] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#124718) #127827
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
…nGH-121278) (python#124718) Make `versionchanged:: next`` expand 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.) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> (cherry picked from commit 7d24ea9) pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73)
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 changes
Dec 11, 2024
|
I'm happy to get this in yeah :) |
|
Thanks @encukou for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10. |
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.
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 in https://github.com/python/cpython/blob/3.11/Doc/requirements-oldest-sphinx.txt:
Co-authored-by: Adam Turner [email protected]
Co-authored-by: Hugo van Kemenade [email protected]
(cherry picked from commit 7d24ea9)
Also backports follow-up GH-124623: Raise nice error on
nextas second argument to deprecated-removed(cherry-picked from e349f73)
.. versionadded:: nextin docs #121277📚 Documentation preview 📚: https://cpython-previews--127827.org.readthedocs.build/