Title: DOC: document how to created interpolated stubs by story645 · Pull Request #28746 · matplotlib/matplotlib · GitHub
Open Graph Title: DOC: document how to created interpolated stubs by story645 · Pull Request #28746 · matplotlib/matplotlib
X Title: DOC: document how to created interpolated stubs by story645 · Pull Request #28746 · matplotlib/matplotlib
Description: PR summary Inspired by the colorizer and InsetArtist PRs that are both adding new objects that get used in a few places/forwarded to, I added a section to the doc docs documenting how to add _docstring.interpd docs. Also deleted note on how we're still debating whether we want to use this functionality because that note was added in 2017 on how this functionality is up for debate b/c either: no decision means decision was to keep status quo and then we should document how to use this nice reusable doc tool we don't want to use this and then we should document "we don't use this, here's what you should do instead" I didn't document how to use the kwdoc functionality b/c I don't understand it enough to: matplotlib/lib/matplotlib/_docstring.py Lines 92 to 102 in 436a12a class _ArtistPropertiesSubstitution(Substitution): """ A `.Substitution` with two additional features: - Substitutions of the form ``%(classname:kwdoc)s`` (ending with the literal ":kwdoc" suffix) trigger lookup of an Artist subclass with the given *classname*, and are substituted with the `.kwdoc` of that class. - Decorating a class triggers substitution both on the class docstring and on the class' ``__init__`` docstring (which is a commonly required pattern for Artist subclasses). """ PR checklist "closes #0000" is in the body of the PR description to link the related issue new and changed code is tested Plotting related features are demonstrated in an example New Features and API Changes are noted with a directive and release note Documentation complies with general and docstring guidelines
Open Graph Description: PR summary Inspired by the colorizer and InsetArtist PRs that are both adding new objects that get used in a few places/forwarded to, I added a section to the doc docs documenting how to add _docs...
X Description: PR summary Inspired by the colorizer and InsetArtist PRs that are both adding new objects that get used in a few places/forwarded to, I added a section to the doc docs documenting how to add _docs...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/28746
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:1564fb28-3336-0265-391a-55093f4ac790 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | E8D8:1486CD:4E08A0:694679:6A5233CD |
| html-safe-nonce | ae5c784885327be4a14deceaf864b44db0ac9b8ce2bc5a704989375a5339c669 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFOEQ4OjE0ODZDRDo0RTA4QTA6Njk0Njc5OjZBNTIzM0NEIiwidmlzaXRvcl9pZCI6IjczMjM5ODQ3MjgzNjA2MjkxOTciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 0139ca85c9b1ba5f2ef9c04e7f26e9c48a7370ec57383a3627b205fbc0f0a5df |
| hovercard-subject-tag | pull_request:2031351338 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,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/matplotlib/matplotlib/pull/28746/files |
| twitter:image | https://avatars.githubusercontent.com/u/1300499?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1300499?s=400&v=4 |
| og:image:alt | PR summary Inspired by the colorizer and InsetArtist PRs that are both adding new objects that get used in a few places/forwarded to, I added a section to the doc docs documenting how to add _docs... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| diff-view | unified |
| 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 | true |
| 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