Title: Enforce the use of `deprecated-removed` in docs · Issue #92564 · python/cpython · GitHub
Open Graph Title: Enforce the use of `deprecated-removed` in docs · Issue #92564 · python/cpython
X Title: Enforce the use of `deprecated-removed` in docs · Issue #92564 · python/cpython
Description: In the docs we have two directives that can be used to document deprecations: deprecated and deprecated-removed. I think we should always prefer the latter: it will make it easier to track and document removals it will give people a targ...
Open Graph Description: In the docs we have two directives that can be used to document deprecations: deprecated and deprecated-removed. I think we should always prefer the latter: it will make it easier to track and docu...
X Description: In the docs we have two directives that can be used to document deprecations: deprecated and deprecated-removed. I think we should always prefer the latter: it will make it easier to track and docu...
Opengraph URL: https://github.com/python/cpython/issues/92564
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Enforce the use of `deprecated-removed` in docs","articleBody":"In the docs we have two directives that can be used to [document deprecations](https://devguide.python.org/documenting/#paragraph-level-markup): `deprecated` and `deprecated-removed`.\r\n\r\nI think we should always prefer the latter:\r\n* it will make it easier to track and document removals\r\n* it will give people a target, so they can plan around it\r\n\r\nEven if the removal version gets postponed, it's better to postpone than to say that something is deprecated and then just remove it at an unspecified time in the future.\r\n\r\nCurrently `deprecated` is more commonly used:\r\n```\r\n$ grep -r 'deprecated::' --include=*.rst | wc -l\r\n226\r\n$ grep -r 'deprecated-removed::' --include=*.rst | wc -l\r\n30\r\n```\r\n\r\n- [ ] set removal version for deprecated features using `deprecated-removed`\r\n- [ ] automate the documentation of deprecations (see also #92308)\r\n- [ ] possibly deprecate the `deprecated` directive and replace it with `deprecated-removed`","author":{"url":"https://github.com/ezio-melotti","@type":"Person","name":"ezio-melotti"},"datePublished":"2022-05-09T15:31:15.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":12},"url":"https://github.com/92564/cpython/issues/92564"}
| 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:63dcbe21-2bb8-82b8-3f68-a89fd8ba5eb2 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A5D2:12A5F2:44BC5C:5BCE2D:6969C70F |
| html-safe-nonce | 3378d14cfcf750d28e7458cda5db56d24db6acdaea67a2029c5ea27161699bad |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNUQyOjEyQTVGMjo0NEJDNUM6NUJDRTJEOjY5NjlDNzBGIiwidmlzaXRvcl9pZCI6IjM1MTY3OTc0MDUwMjMwMjkwMDciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 1e02261ee63871bfcef7ccaef5cf09d7ac9a3fa6a48b7489d282c3bf14b661e1 |
| hovercard-subject-tag | issue:1229903909 |
| 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/92564/issue_layout |
| twitter:image | https://opengraph.githubassets.com/5b7c948db351f6d1083da6338cb9692552aaf9f53f507574e0c22fea1cfaf365/python/cpython/issues/92564 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/5b7c948db351f6d1083da6338cb9692552aaf9f53f507574e0c22fea1cfaf365/python/cpython/issues/92564 |
| og:image:alt | In the docs we have two directives that can be used to document deprecations: deprecated and deprecated-removed. I think we should always prefer the latter: it will make it easier to track and docu... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | ezio-melotti |
| hostname | github.com |
| expected-hostname | github.com |
| None | acedec8b5f975d9e3d494ddd8f949b0b8a0de59d393901e26f73df9dcba80056 |
| 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 | 83c08c21cdda978090dc44364b71aa5bc6dcea79 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width