Title: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. by anntzer · Pull Request #21140 · matplotlib/matplotlib · GitHub
Open Graph Title: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. by anntzer · Pull Request #21140 · matplotlib/matplotlib
X Title: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. by anntzer · Pull Request #21140 · matplotlib/matplotlib
Description: [notes section required to get data note injection right] has been obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them. loglog, semilogx, semilogy are thin wrappers around plot; it seems fine to not document data there and leave it implicitly part of **kwargs: all parameters supported by plot. Then "Other Parameters" only contains **kwargs whose description is quite short, so it can just be lifted into the main Parameters section rather than requiring a separate section just for itself. Likewise for step, but that method actually explicitly lists data in its signature, so just move its (already existing) description down to its correct position. This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER is not correctly handled for these simple plot() wrappers; because they all operate without going through _preprocess_data(), fixing them would also require their own ad-hoc solution anyways. (#21135) PR Summary PR Checklist Has pytest style unit tests (and pytest passes). Is Flake 8 compliant (run flake8 on changed files to check). New features are documented, with examples if plot related. Documentation is sphinx and numpydoc compliant (the docs should build without error). Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all). New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there). API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
Open Graph Description: [notes section required to get data note injection right] has been obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them. loglog, semilogx, semilogy are thin wrappers around plot; it seems fine ...
X Description: [notes section required to get data note injection right] has been obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them. loglog, semilogx, semilogy are thin wrappers around plot; it seems fine ...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/21140
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:0a97295a-0129-6d60-5342-ed5a0ebabc4a |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | DF98:260009:1B0A81E:23FE6E0:6A52CE55 |
| html-safe-nonce | 4ce4e73de2136783b7e71eb0b939b3c2b15873000c5fe1d87e23717962abb9a7 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJERjk4OjI2MDAwOToxQjBBODFFOjIzRkU2RTA6NkE1MkNFNTUiLCJ2aXNpdG9yX2lkIjoiOTAyNjg2Mjg5MjQxMTE3ODU4MSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 9a005d485e36e25b2f9316f5b2c42ab496ba1a696d8435bb312518f8d7c8cbf6 |
| hovercard-subject-tag | pull_request:737731813 |
| 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/21140/files |
| twitter:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| og:image:alt | [notes section required to get data note injection right] has been obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them. loglog, semilogx, semilogy are thin wrappers around plot; it seems fine ... |
| 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 | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width