Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Allow.. versionadded:: next in docs #121277

Closed
Labels
docsDocumentation in the Doc dirtype-featureA feature request or enhancement
@encukou

Description

@encukou

Feature or enhancement

Proposal:

In a PR to CPython, theversionadded,versionchanged,versionremoved,deprecated,deprecated-removed directives in documentation should currently be set to the upcoming release.

This is inconvenient:

  • the numbers need to be changed in backports
  • if a PR misses a feature release, the number needs to be updated

It would be good to treat this more like News entries, which live in anext/ directory before a release, when the release manager bundles them up and assigns a version.

Concrete proposal:

  • Teachversionadded & the others to expand the version argumentnext to<version> (unreleased) (e.g.3.14.0b0 (unreleased)).
  • Add a tool that replaces thenext with a given string (e.g.3.14).
  • Modify the release manager tooling to run the tool on release.
  • Add a check to release manager tooling thatbuilt HTML documentation for a fresh release does not include the string(unreleased). The RM should be able to skip this test, in case of a false positive.
  • Update the Devguide.
  • Announce in Discourse

Has this already been discussed elsewhere?

I have already discussed this feature proposal on Discourse

Links to previous discussion of this feature:

https://discuss.python.org/t/automating-versionadded-changed-markers-in-docs-to-expedite-prs/38423

Linked PRs

Related PRs

Discourse announcement

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp