GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-121277: Raise nice error on `next` as second argument to deprecated-removed by encukou · Pull Request #124623 · python/cpython

Conversation

@encukou

@encukou encukou commented Sep 26, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Using next as the second argument doesn't make sense, but users should get a nicer message than ValueError: invalid literal for int() -- especially since Sphinx hides the traceback by default.

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@encukou
pythongh-121277: Raise nice error on next as second argument to dep…
3cc4298 
…recated-removed
@bedevere-app bedevere-app Bot added the awaiting core review label Sep 26, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Sep 26, 2024
Allow .. versionadded:: next in docs #121277
Closed
6 tasks done
@encukou encukou mentioned this pull request Sep 26, 2024
Document next in versionadded & similar directives python/devguide#1413
Merged
ezio-melotti
ezio-melotti approved these changes Sep 26, 2024
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/tools/extensions/pyspecific.py
Comment on lines +291 to +293
if version_removed == 'next':
raise ValueError(
'deprecated-removed:: second argument cannot be `next`')

@ezio-melotti ezio-melotti Sep 26, 2024

Copy link
Copy Markdown
Member

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
if version_removed == 'next':
raise ValueError(
'deprecated-removed:: second argument cannot be `next`')
if version_removed == 'next':
raise ValueError(
'deprecated-removed:: second argument should be the version in which '
'the API will be removed, and cannot be `next`')

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@encukou encukou Sep 26, 2024

Copy link
Copy Markdown
Member Author

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 adds deprecated-removed:: already knows what the args are. If they need this error to find that out, something's very wrong :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Sep 26, 2024
@encukou encukou added the skip news label Sep 26, 2024
@encukou
encukou merged commit e349f73 into python:main Sep 27, 2024
@bedevere-app bedevere-app Bot removed the awaiting merge label Sep 27, 2024
@encukou
encukou deleted the deprecated-removed-next branch September 27, 2024 23:02
encukou added a commit to encukou/cpython that referenced this pull request Sep 27, 2024
@encukou
pythongh-121277: Raise nice error on next as second argument to dep…
99cae0e 
…recated-removed (pythonGH-124623)

(cherry-picked from e349f73)
@encukou encukou mentioned this pull request Sep 27, 2024
[3.13] gh-121277: Allow .. versionadded:: next in docs (GH-121278) #124718
Merged
encukou added a commit that referenced this pull request Oct 25, 2024
@encukou
[3.13] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#…
dba992b 
…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 <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
(cherry picked from commit 7d24ea9)

* gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)

(cherry-picked from e349f73)
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 25, 2024
@encukou @miss-islington
[3.13] pythongh-121277: Allow .. versionadded:: next in docs (pytho…
5e2b229 
…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 <[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)
(cherry picked from commit dba992b)

Co-authored-by: Petr Viktorin <[email protected]>
@miss-islington 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
encukou added a commit that referenced this pull request Oct 28, 2024
@miss-islington @encukou
[3.12] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (G…
1e01dcf 
…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 <[email protected]>
encukou added a commit to encukou/cpython that referenced this pull request Dec 11, 2024
@encukou
[3.11] pythongh-121277: Allow .. versionadded:: next in docs (pytho…
f456e6f 
…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)
@encukou encukou mentioned this pull request Dec 11, 2024
[3.11] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#124718) #127827
Merged
pablogsal pushed a commit that referenced this pull request Dec 11, 2024
@encukou
[3.11] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#…
f0895aa 
…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 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)

gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)

(cherry-picked from e349f73)

* Import VersionChange

sphinx.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 request Dec 12, 2024
@encukou
[3.10] pythongh-121277: Allow .. versionadded:: next in docs (pythonG…
46ba07c 
…H-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 <[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)

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 request Dec 12, 2024
@encukou
[3.10] pythongh-121277: Allow .. versionadded:: next in docs (pythonG…
eb042df 
…H-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 <[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)

Updates for 3.10

(cherry-picked from 3.11: f0895aa)

* Use version, not arguments directly
@encukou encukou mentioned this pull request Dec 12, 2024
[3.10] gh-121277: Allow .. versionadded:: next in docs (GH-121278) #127867
Merged
pablogsal pushed a commit that referenced this pull request Dec 13, 2024
@encukou
[3.10] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#…
8773554 
…127867)

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)

gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)

(cherry-picked from e349f73)

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 request Dec 20, 2024
@encukou
[3.9] pythongh-121277: Allow .. versionadded:: next in docs (pythonGH…
65f01bb 
…-121278) (pythonGH-127867)

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)

Updates for 3.9

(cherry-picked from 3.11: f0895aa)
(cherry-picked from 3.10: 8773554)

* Use version, not arguments directly
@encukou encukou mentioned this pull request Dec 20, 2024
[3.9] gh-121277: Allow .. versionadded:: next in docs (GH-121278) #128117
Merged
ambv pushed a commit that referenced this pull request Jan 23, 2025
@encukou
[3.9] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#1…
8c8a257 
…28117)

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)

gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623)

(cherry-picked from e349f73)
(cherry-picked from 3.11: f0895aa)
(cherry-picked from 3.10: 8773554)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melotti ezio-melotti ezio-melotti approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@encukou @ezio-melotti
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.