gh-121277: Allow `.. versionadded:: next` in docs #121278

encukou · 2024-07-02T17:10:13Z

Issue: Allow .. versionadded:: next in docs #121277

📚 Documentation preview 📚: https://cpython-previews--121278.org.readthedocs.build/

- versionadded, versionchanged, and similar directives expand "next" to e.g. "3.14.0a0 (unreleased)". - A tool is provided for release managers to replace all such occurences of "next" with the given string.

gpshead

This looks simpler to implement than I expected it might be, nice!

Doc/tools/extensions/pyspecific.py

AA-Turner

Looks good -- a few comments

Doc/tools/version_next.py

Doc/tools/extensions/pyspecific.py

bedevere-app · 2024-07-18T13:55:11Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

Doc/tools/version_next.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner · 2024-07-19T10:36:25Z

@encukou are you happy if we merge #121971 before this one?

encukou · 2024-07-19T10:36:57Z

Sure.

encukou · 2024-07-19T10:40:23Z

I'll fix the conflicts.

Doc/tools/extensions/pyspecific.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

encukou · 2024-08-16T16:01:37Z

Thanks for the reviews, everyone!
I've sent the tool to the release-tools repo: python/release-tools#164. (That uses a different linter, so I'll ignore the style nits here.)

Next week I'll get to removing the tool from this PR.

encukou · 2024-09-24T20:20:33Z

Not exactly next week, but, the tool is now in release-tools and this PR is ready for review again.

AA-Turner

Thanks Petr!

A

hugovk

Thanks! When merged, please could you drop a note on Discuss to let people know?

encukou · 2024-09-25T21:30:53Z

Will do that after the Devguide PR.

* main: (69 commits) Add "annotate" SET_FUNCTION_ATTRIBUTE bit to dis. (python#124566) pythongh-124412: Add helpers for converting annotations to source format (python#124551) pythongh-119180: Disallow instantiation of ConstEvaluator objects (python#124561) For-else deserves its own section in the tutorial (python#123946) Add 3.13 as a version option to the crash issue template (python#124560) pythongh-123242: Note that type.__annotations__ may not exist (python#124557) pythongh-119180: Make FORWARDREF format look at __annotations__ first (python#124479) pythonGH-58058: Add quick reference for `ArgumentParser` to argparse docs (pythongh-124227) pythongh-41431: Add `datetime.time.strptime()` and `datetime.date.strptime()` (python#120752) pythongh-102450: Add ISO-8601 alternative for midnight to `fromisoformat()` calls. (python#105856) pythongh-124370: Add "howto" for free-threaded Python (python#124371) pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278) pythongh-119400: make_ssl_certs: update reference test data automatically, pass in expiration dates as parameters python#119400 (pythonGH-119401) pythongh-119180: Avoid going through AST and eval() when possible in annotationlib (python#124337) pythongh-124448: Update Windows builds to use Tcl/Tk 8.6.15 (pythonGH-124449) pythongh-123884 Tee of tee was not producing n independent iterators (pythongh-124490) pythongh-124378: Update test_ttk for Tcl/Tk 8.6.15 (pythonGH-124542) pythongh-124513: Check args in framelocalsproxy_new() (python#124515) pythongh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (python#124480) Doc: Use ``major.minor`` for documentation distribution archive filenames (python#124489) ...

miss-islington-app · 2024-09-27T22:28:38Z

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app · 2024-09-27T22:28:41Z

Sorry, @encukou, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 7d24ea9db3e8fdca52058629c9ba577aba3d8e5c 3.13

) 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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9)

bedevere-app · 2024-09-27T23:09:42Z

GH-124718 is a backport of this pull request to the 3.13 branch.

…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 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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) * gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from e349f73)

…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 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 <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) * pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73) (cherry picked from commit dba992b) Co-authored-by: Petr Viktorin <encukou@gmail.com>

…H-125980) 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.) (cherry picked from commit 7d24ea9) Also backports a minor fix-up: gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from commit e349f73) Co-authored-by: Petr Viktorin <encukou@gmail.com>

encukou added 2 commits July 2, 2024 18:39

Make versionchanged:: next` expand to current (unreleased) version

f0005e7

- versionadded, versionchanged, and similar directives expand "next" to e.g. "3.14.0a0 (unreleased)". - A tool is provided for release managers to replace all such occurences of "next" with the given string.

Use in existing docs

0c86239

bedevere-app bot mentioned this pull request Jul 2, 2024

Allow .. versionadded:: next in docs #121277

Open

6 tasks

gpshead approved these changes Jul 12, 2024

View reviewed changes

bedevere-app bot added the awaiting merge label Jul 12, 2024

encukou commented Jul 18, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

AA-Turner reviewed Jul 18, 2024

View reviewed changes

AA-Turner requested changes Jul 18, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

bedevere-app bot removed the awaiting merge label Jul 18, 2024

bedevere-app bot added the awaiting changes label Jul 18, 2024

merwok reviewed Jul 18, 2024

View reviewed changes

Doc/tools/version_next.py Outdated Show resolved Hide resolved

encukou and others added 9 commits July 19, 2024 11:54

Apply extension suggestions from code review

e270ddc

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/tools/extensions/pyspecific.py

0022e1a

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Fix location of the the Doc dir

342838d

Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Specify encoding

1d9a618

Improve the docstring/usage

311bceb

Re-add stray removed line

72a3162

Split long line

91bd511

Set env before using it

46ae814

Add a blurb

9c4502c

Merge in the main branch

426aae1

AA-Turner reviewed Jul 19, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Consolidate VersionChange imports

993dd5c

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner approved these changes Jul 19, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting changes labels Jul 19, 2024

hugovk mentioned this pull request Aug 25, 2024

cpython#121277: Replace next versions in docs by the just-released version python/release-tools#164

Merged

encukou added 2 commits September 24, 2024 11:11

Remove the tool; that now lives in the release-tools repo

757cf6b

Merge in the main branch

7136c0e

encukou marked this pull request as ready for review September 24, 2024 20:18

encukou requested a review from barneygale as a code owner September 24, 2024 20:19

bedevere-app bot added awaiting core review and removed awaiting merge labels Sep 24, 2024

AA-Turner approved these changes Sep 24, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting core review labels Sep 24, 2024

gpshead approved these changes Sep 24, 2024

View reviewed changes

hugovk approved these changes Sep 24, 2024

View reviewed changes

encukou merged commit 7d24ea9 into python:main Sep 25, 2024
27 checks passed

bedevere-app bot removed the awaiting merge label Sep 25, 2024

encukou deleted the versionchange-next branch September 25, 2024 21:30

encukou added the needs backport to 3.13 bugs and security fixes label Sep 27, 2024

miss-islington-app bot assigned encukou Sep 27, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 27, 2024

miss-islington mentioned this pull request Oct 25, 2024

[3.12] [3.13] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (GH-124718) #125980

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-121277: Allow `.. versionadded:: next` in docs #121278

gh-121277: Allow `.. versionadded:: next` in docs #121278

encukou commented Jul 2, 2024 •

edited by github-actions bot

Loading

gpshead left a comment

AA-Turner left a comment

bedevere-app bot commented Jul 18, 2024

AA-Turner commented Jul 19, 2024

encukou commented Jul 19, 2024

encukou commented Jul 19, 2024

encukou commented Aug 16, 2024 •

edited

Loading

encukou commented Sep 24, 2024

AA-Turner left a comment

hugovk left a comment

encukou commented Sep 25, 2024

miss-islington-app bot commented Sep 27, 2024

miss-islington-app bot commented Sep 27, 2024

bedevere-app bot commented Sep 27, 2024

gh-121277: Allow .. versionadded:: next in docs #121278

gh-121277: Allow .. versionadded:: next in docs #121278

Conversation

encukou commented Jul 2, 2024 • edited by github-actions bot Loading

gpshead left a comment

Choose a reason for hiding this comment

AA-Turner left a comment

Choose a reason for hiding this comment

bedevere-app bot commented Jul 18, 2024

AA-Turner commented Jul 19, 2024

encukou commented Jul 19, 2024

encukou commented Jul 19, 2024

encukou commented Aug 16, 2024 • edited Loading

encukou commented Sep 24, 2024

AA-Turner left a comment

Choose a reason for hiding this comment

hugovk left a comment

Choose a reason for hiding this comment

encukou commented Sep 25, 2024

miss-islington-app bot commented Sep 27, 2024

miss-islington-app bot commented Sep 27, 2024

bedevere-app bot commented Sep 27, 2024

gh-121277: Allow `.. versionadded:: next` in docs #121278

gh-121277: Allow `.. versionadded:: next` in docs #121278

encukou commented Jul 2, 2024 •

edited by github-actions bot

Loading

encukou commented Aug 16, 2024 •

edited

Loading