Title: Allow `.. versionadded:: next` in docs · Issue #121277 · python/cpython · GitHub
Open Graph Title: Allow `.. versionadded:: next` in docs · Issue #121277 · python/cpython
X Title: Allow `.. versionadded:: next` in docs · Issue #121277 · python/cpython
Description: Feature or enhancement Proposal: In a PR to CPython, the versionadded, versionchanged, versionremoved, deprecated, deprecated-removed directives in documentation should currently be set to the upcoming release. This is inconvenient: the ...
Open Graph Description: Feature or enhancement Proposal: In a PR to CPython, the versionadded, versionchanged, versionremoved, deprecated, deprecated-removed directives in documentation should currently be set to the upco...
X Description: Feature or enhancement Proposal: In a PR to CPython, the versionadded, versionchanged, versionremoved, deprecated, deprecated-removed directives in documentation should currently be set to the upco...
Opengraph URL: https://github.com/python/cpython/issues/121277
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Allow `.. versionadded:: next` in docs","articleBody":"# Feature or enhancement\r\n\r\n### Proposal:\r\n\r\nIn a PR to CPython, the `versionadded`, `versionchanged`, `versionremoved`, `deprecated`, `deprecated-removed` directives in documentation should currently be set to the upcoming release.\r\n\r\nThis is inconvenient:\r\n- the numbers need to be changed in backports\r\n- if a PR misses a feature release, the number needs to be updated\r\n\r\nIt would be good to treat this more like News entries, which live in a `next/` directory before a release, when the release manager bundles them up and assigns a version.\r\n\r\nConcrete proposal:\r\n\r\n- [x] Teach `versionadded` \u0026 the others to expand the version argument `next` to `\u003cversion\u003e (unreleased)` (e.g. `3.14.0b0 (unreleased)`).\r\n- [x] Add a tool that replaces the `next` with a given string (e.g. `3.14`).\r\n- [x] Modify the release manager tooling to run the tool on release.\r\n- [x] Add a check to release manager tooling that *built* 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.\r\n- [x] Update the Devguide.\r\n- [x] Announce in Discourse\r\n\r\n\r\n### Has this already been discussed elsewhere?\r\n\r\nI have already discussed this feature proposal on Discourse\r\n\r\n### Links to previous discussion of this feature:\r\n\r\nhttps://discuss.python.org/t/automating-versionadded-changed-markers-in-docs-to-expedite-prs/38423\r\n\r\n\u003c!-- gh-linked-prs --\u003e\r\n### Linked PRs\r\n* gh-121278\r\n* gh-124623\r\n* gh-124718\n* gh-125980\n* gh-127827\n* gh-127867\n* gh-128117\n\u003c!-- /gh-linked-prs --\u003e\r\n\r\n### Related PRs\r\n\r\n* release-tools PR: https://github.com/python/release-tools/pull/164\r\n* devguide PR: https://github.com/python/devguide/pull/1413\r\n\r\n### Discourse announcement\r\n\r\n* https://discuss.python.org/t/versionadded-next/65280","author":{"url":"https://github.com/encukou","@type":"Person","name":"encukou"},"datePublished":"2024-07-02T17:08:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":10},"url":"https://github.com/121277/cpython/issues/121277"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:1622708b-421d-ba01-1b26-5c87030991be |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 953A:1D772C:28280A6:34F6C25:696B2A29 |
| html-safe-nonce | 5b357192257067116e63bb998d8ba1161edd93577c67b7c8a8a69b8c46ee541c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NTNBOjFENzcyQzoyODI4MEE2OjM0RjZDMjU6Njk2QjJBMjkiLCJ2aXNpdG9yX2lkIjoiMzg5ODgyMjAwMjgzNDM1MjY4MSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 28070d9cbb281246b37329da096365e16645f67c1a492e6d69052b958a96061f |
| hovercard-subject-tag | issue:2386753765 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/121277/issue_layout |
| twitter:image | https://opengraph.githubassets.com/a00f78156ade2c775fae170cbc7f79c8b7cd73a01b353229f92227a1a7a98c76/python/cpython/issues/121277 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/a00f78156ade2c775fae170cbc7f79c8b7cd73a01b353229f92227a1a7a98c76/python/cpython/issues/121277 |
| og:image:alt | Feature or enhancement Proposal: In a PR to CPython, the versionadded, versionchanged, versionremoved, deprecated, deprecated-removed directives in documentation should currently be set to the upco... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | encukou |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 82560a55c6b2054555076f46e683151ee28a19bc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width