cpython#121277: Replace next versions in docs by the just-released version
#164
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
Member
Author
|
Dear RMs, do you want this? I can add tests for the remaining uncovered lines; is this the style of tests you're looking for? |
hugovk
reviewed
Aug 25, 2024
Member
Yes, I think so, but still need to take a closer look, and would also like to hear from other RMs who have actually made releases :)
I've not had a proper look yet, but will do. |
Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk
reviewed
Sep 4, 2024
Member
hugovk
left a comment
hugovk
left a comment
There was a problem hiding this comment.
Looking good, I tested it against python/cpython#121278 and it worked as expected.
Here's a few small suggestions.
hugovk
reviewed
Sep 4, 2024
Co-authored-by: Hugo van Kemenade <[email protected]>
6 tasks
Member
Author
|
On the sprint, @Yhg1s agreed to the concept, so I'll merge. I'll link related PRs on the CPython issue: python/cpython#121277 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
See CPython issue: python/cpython#121277
After the CPython PR is merged, a Sphinx plugin will expand
nextin directives likeversionchangedto e.g.3.14.0b0 (unreleased).This PR gives the RM a tool to replace all such occurences of
nextby the currently released version, baking it directly into the ReST source files, as part of the version bump commit.This is done textually (I don't know of a round-trip parser for ReST).
To make sure the text manipulation worked, the released docs artifact (if it's being published) is grepped for the string
(unreleased), and if it's found, the RM is asked for confirmation.