Title: [Doc]: add sphinx versioning directives · Issue #23506 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: add sphinx versioning directives · Issue #23506 · matplotlib/matplotlib
X Title: [Doc]: add sphinx versioning directives · Issue #23506 · matplotlib/matplotlib
Description: Documentation Link No response Problem It can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks think would be a good idea) could be flagged...
Open Graph Description: Documentation Link No response Problem It can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks thin...
X Description: Documentation Link No response Problem It can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks thin...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/23506
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: add sphinx versioning directives","articleBody":"### Documentation Link\r\n\r\n_No response_\r\n\r\n### Problem\r\n\r\nIt can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks think would be a good idea) could be flagged with a version added/changed/etc directive. \r\n\r\n### Suggested improvement\r\n\r\nIntroduce the [versioning directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=versionadded#directive-versionadded)\r\n\r\nPer the call ([link](https://hackmd.io/49a-u44CTja02xQRaG88JA?both#other-comments)), a first step is to create a pr with some sample directives:\r\n- https://github.com/matplotlib/matplotlib/pull/24160\r\n\r\nAdditionally sort out guidance for adding directive (to which prs) and update PR guidelines accordingly :\r\n- https://github.com/matplotlib/matplotlib/pull/24161\r\n\r\nAs a first pass, my guess is anything that gets a what's new should get a version added, anything that gets an api change should get a versionchanged, and `deprecated` is already added as part of the decorator https://github.com/matplotlib/matplotlib/blob/862f85d37a0f0da270d93aa3a59157bb9f1553d3/lib/matplotlib/_api/deprecation.py#L210","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2022-07-28T20:58:58.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":14},"url":"https://github.com/23506/matplotlib/issues/23506"}
| 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:f7a3c15a-e1f4-8a58-b8bf-8231706f5046 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C2F0:1A8C4D:6993CB:8E26C6:6A51F096 |
| html-safe-nonce | ff72b162b82b09a2dc60b9480461cfd7a730665608db967622ec24f77a482101 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMkYwOjFBOEM0RDo2OTkzQ0I6OEUyNkM2OjZBNTFGMDk2IiwidmlzaXRvcl9pZCI6IjQ1Nzg0MTk1MjI4MTg2NjY2NDYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | c4316d41e098fdbadd76d1b9a71f135dd580dcb0b8daedd1f3c7b62d656c5594 |
| hovercard-subject-tag | issue:1321480369 |
| 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/matplotlib/matplotlib/23506/issue_layout |
| twitter:image | https://opengraph.githubassets.com/1bb6024ed97aaeb19767879bf7ba14a60177b0dc36738810d45e5fd0512fd532/matplotlib/matplotlib/issues/23506 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/1bb6024ed97aaeb19767879bf7ba14a60177b0dc36738810d45e5fd0512fd532/matplotlib/matplotlib/issues/23506 |
| og:image:alt | Documentation Link No response Problem It can be unclear which features were added when just by looking at the docs, and would be helpful if at at least major features (and whatever else folks thin... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | story645 |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| 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 | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | canary-1 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width