Title: Formalize discouraged API (= softer deprecations) · Issue #19017 · matplotlib/matplotlib · GitHub
Open Graph Title: Formalize discouraged API (= softer deprecations) · Issue #19017 · matplotlib/matplotlib
X Title: Formalize discouraged API (= softer deprecations) · Issue #19017 · matplotlib/matplotlib
Description: Proposal Some parts of our API should not be used anymore. However they are potentially too widely used so that we cannot deprecate them. We sometimes informally use "soft deprecation" for these. I propose to call these "discouraged API"...
Open Graph Description: Proposal Some parts of our API should not be used anymore. However they are potentially too widely used so that we cannot deprecate them. We sometimes informally use "soft deprecation" for these. I...
X Description: Proposal Some parts of our API should not be used anymore. However they are potentially too widely used so that we cannot deprecate them. We sometimes informally use "soft deprecation" fo...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/19017
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Formalize discouraged API (= softer deprecations)","articleBody":"### Proposal\r\n\r\nSome parts of our API should not be used anymore. However they are potentially too widely used so that we cannot deprecate them. We sometimes informally use \"soft deprecation\" for these.\r\n\r\nI propose to call these \"discouraged API\" instead and formalize what that means.\r\n\r\n### Details\r\n\r\nTerminology: \"deprecated\" has the connotation of being removed some time in the future. \"soft-deprecated\" is not a well-defined and commonly known term AFAICS. So \"discouraged\" is more clear to the end-user.\r\n\r\nWe'll then have to following categories of API not to be used anymore:\r\n\r\n- *deprecated*: Has a removal version set.\r\n- *pending deprecation*: Is planned to be deprecated in the future. This is essentially a signal to downstream libraries that they should not use this anymore, and can prevent end users seeing deprecation warnings from internal Matplotlib calls of downstream libraries.\r\n- *discouraged*: Should not be used, but will be available indefinitely for backward compatibility.\r\n\r\nDeprecations and pending deprecations have already a formalized way of documentation and warning.\r\n\r\nDiscouraged API should get a corresponding note in the docs. To be discussed whether we also want to warn on it's usage. I tend to say no to not annoy users.\r\n\r\n","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2020-11-26T02:01:21.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":9},"url":"https://github.com/19017/matplotlib/issues/19017"}
| 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:ac4f6c67-cf57-d7c9-4c35-b8c0cfeb0734 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 823A:D3171:1017399:155DC94:6A51C545 |
| html-safe-nonce | 7d19b444d7888ab18fcb6bf1d8df82e9d5cc416bf9a57f20c05e765bd4fe29f2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MjNBOkQzMTcxOjEwMTczOTk6MTU1REM5NDo2QTUxQzU0NSIsInZpc2l0b3JfaWQiOiIxMzk4NjAyMTIyNTc3MTY3Njg1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 563bf836367ac91447aebc941718880fcb1ceff68f1580c5cca7fdc826f30947 |
| hovercard-subject-tag | issue:751223833 |
| 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/19017/issue_layout |
| twitter:image | https://opengraph.githubassets.com/1dc57d364aef0fe94da96b23798044cec92d308894771ac6d9ff91fa7a208472/matplotlib/matplotlib/issues/19017 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/1dc57d364aef0fe94da96b23798044cec92d308894771ac6d9ff91fa7a208472/matplotlib/matplotlib/issues/19017 |
| og:image:alt | Proposal Some parts of our API should not be used anymore. However they are potentially too widely used so that we cannot deprecate them. We sometimes informally use "soft deprecation" for these. I... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | timhoffm |
| 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 | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width