Title: Review documentation of Axes plotting methods · Issue #10148 · matplotlib/matplotlib · GitHub
Open Graph Title: Review documentation of Axes plotting methods · Issue #10148 · matplotlib/matplotlib
X Title: Review documentation of Axes plotting methods · Issue #10148 · matplotlib/matplotlib
Description: As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular: Conversion to numpydoc format. Improvements on the descriptions. I intend to go through the methods and update their docs. ...
Open Graph Description: As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular: Conversion to numpydoc format. Improvements on the descriptions. I intend to go thr...
X Description: As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular: Conversion to numpydoc format. Improvements on the descriptions. I intend to go thr...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/10148
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Review documentation of Axes plotting methods","articleBody":"As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular:\r\n\r\n- Conversion to numpydoc format.\r\n- Improvements on the descriptions.\r\n\r\nI intend to go through the methods and update their docs. This is a summary issue to keep track of my progress: \r\n\r\n### Basic\r\n\r\n- [x] `Axes.plot`\r\n- [x] `Axes.errorbar`\r\n- [x] `Axes.scatter`\r\n- [x] `Axes.plot_date`\r\n- [x] `Axes.step`\r\n- [x] `Axes.loglog`\r\n- [x] `Axes.semilogx`\r\n- [x] `Axes.semilogy`\r\n- [x] `Axes.fill_between`\r\n- [x] `Axes.fill_betweenx`\r\n- [x] `Axes.bar`\r\n- [x] `Axes.barh`\r\n- [x] `Axes.stem`\r\n- [x] `Axes.eventplot`\r\n- [x] `Axes.pie`\r\n- [x] `Axes.stackplot`\r\n- [x] `Axes.broken_barh`\r\n- [x] `Axes.vlines`\r\n- [x] `Axes.hlines`\r\n- [x] `Axes.fill`\r\n\r\n### Spans\r\n\r\n- [x] `Axes.axhline`\r\n- [x] `Axes.axhspan`\r\n- [x] `Axes.axvline`\r\n- [x] `Axes.axvspan`\r\n\r\n### Spectral\r\n\r\n- [x] `Axes.acorr`\r\n- [x] `Axes.angle_spectrum`\r\n- [x] `Axes.cohere`\r\n- [x] `Axes.csd`\r\n- [x] `Axes.magnitude_spectrum`\r\n- [x] `Axes.phase_spectrum`\r\n- [x] `Axes.psd`\r\n- [x] `Axes.specgram`\r\n- [x] `Axes.xcorr`\r\n\r\n### Statistics\r\n\r\n- [x] `Axes.boxplot`\r\n- [x] `Axes.violinplot`\r\n- [x] `Axes.violin`\r\n- [x] `Axes.bxp`\r\n\r\n### Binned \r\n\r\n- [x] `Axes.hexbin`\r\n- [x] `Axes.hist`\r\n- [x] `Axes.hist2d`\r\n\r\n### Contours\r\n\r\n- [x] `Axes.clabel`\r\n- [x] `Axes.contour`\r\n- [x] `Axes.contourf`\r\n\r\n### Array\r\n\r\n- [x] `Axes.imshow`\r\n- [x] `Axes.matshow`\r\n- [x] `Axes.pcolor`\r\n- [x] `Axes.pcolorfast`\r\n- [x] `Axes.pcolormesh`\r\n- [x] `Axes.spy`\r\n\r\n### Unstructured triangles\r\n\r\n- [x] `Axes.tripcolor`\r\n- [x] `Axes.triplot`\r\n- [x] `Axes.tricontour`\r\n- [x] `Axes.tricontourf`\r\n\r\n### Text and Annotations\r\n\r\n- [x] `Axes.annotate`\r\n- [x] `Axes.text`\r\n- [x] `Axes.table`\r\n- [x] `Axes.arrow`\r\n\r\n### Fields\r\n\r\n- [x] `Axes.barbs`\r\n- [x] `Axes.quiver`\r\n- [x] `Axes.quiverkey`\r\n- [x] `Axes.streamplot`\r\n\r\n## Axes limits and direction\r\n\r\n- [x] `Axes.invert_xaxis`\r\n- [x] `Axes.xaxis_inverted`\r\n- [x] `Axes.invert_yaxis`\r\n- [x] `Axes.yaxis_inverted`\r\n- [x] `Axes.set_xlim`\r\n- [x] `Axes.get_xlim`\r\n- [x] `Axes.set_ylim`\r\n- [x] `Axes.get_ylim`\r\n- [x] `Axes.update_datalim`\r\n- [x] `Axes.update_datalim_bounds`\r\n- [x] `Axes.set_xbound`\r\n- [x] `Axes.get_xbound`\r\n- [x] `Axes.set_ybound`\r\n- [x] `Axes.get_ybound`\r\n\r\n## Axes scales\r\n\r\n- [x] `Axes.get_xscale`\r\n- [x] `Axes.set_xscale`\r\n- [x] `Axes.get_yscale`\r\n- [x] `Axes.set_yscale`\r\n\r\n\u003cs\u003eNote: I currently update the docstrings in my private branch https://github.com/timhoffm/matplotlib/tree/axes-plotting-docstrings and will provide a pull request once I'm done. I think this is better than opening a separate pull request for every change. Please let me know, in case you'd rather prefer many smaller PRs.\u003c/s\u003e\r\n\r\nThe fixes will be supplied in a series of PRs referencing this issue.\r\n\r\n \r\n\r\n\r\n \r\n ","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2018-01-03T18:43:15.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":11},"url":"https://github.com/10148/matplotlib/issues/10148"}
| 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:b5de3105-1ce6-6f52-d12f-3c45858f6ca5 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | DBB8:2D0224:16EEF71:1F1EEC6:6A522A69 |
| html-safe-nonce | d74f343633003114d0d91f0b38a76846237aff44f345556bb885665027cccdc2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEQkI4OjJEMDIyNDoxNkVFRjcxOjFGMUVFQzY6NkE1MjJBNjkiLCJ2aXNpdG9yX2lkIjoiNTk1NTQwOTQ0OTc4MzAxMTk0NSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 5b7fe782a1d121b1f0e85cc67720d286f5f15f143405859d7be9ec6f003ddaf0 |
| hovercard-subject-tag | issue:285773894 |
| 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/10148/issue_layout |
| twitter:image | https://opengraph.githubassets.com/dd20a60aca81042ca41cf5d3cf27a6f40dd719dff74369e487b6326232cf9356/matplotlib/matplotlib/issues/10148 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/dd20a60aca81042ca41cf5d3cf27a6f40dd719dff74369e487b6326232cf9356/matplotlib/matplotlib/issues/10148 |
| og:image:alt | As a follow up of #7205, some docstrings of the basic Axes plotting methods could need a bit care. In particular: Conversion to numpydoc format. Improvements on the descriptions. I intend to go thr... |
| 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