Title: [MNT]: document linestyle as an mpltype · Issue #28745 · matplotlib/matplotlib · GitHub
Open Graph Title: [MNT]: document linestyle as an mpltype · Issue #28745 · matplotlib/matplotlib
X Title: [MNT]: document linestyle as an mpltype · Issue #28745 · matplotlib/matplotlib
Description: Summary The manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using :mpltypes and _docstring.interp that we can then use to have a consistent way to document lines...
Open Graph Description: Summary The manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using :mpltypes and _docstring.interp that we can then use to...
X Description: Summary The manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using :mpltypes and _docstring.interp that we can then use to...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/28745
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[MNT]: document linestyle as an mpltype","articleBody":"### Summary\r\n\r\nThe manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using `:mpltypes` and `_docstring.interp` that we can then use to have a consistent way to document linestyle across the library. \r\n\r\n### Proposed fix\r\n\r\n1. Make something the following table `linestyle_doc` for _docstyle.interpd:\r\n```rst\r\n ========================================== =================\r\n linestyle description\r\n ========================================== =================\r\n ``'-'`` ``'solid'`` solid line\r\n ``'--'`` or ``'dashed'`` dashed line\r\n ``'-.'`` or ``'dashdot'`` dash-dotted line\r\n ``':'`` or ``'dotted'`` dotted line\r\n ``'none'``, ``'None'``, ``' '``, or ``''`` draw nothing\r\n ========================================== =================\r\n```\r\n\r\n2. Add something like that table to [linestyles reference](https://matplotlib.org/devdocs/gallery/lines_bars_and_markers/linestyles.html) (apparently can't reuse the interp in examples :/)\r\n4. Add linestyles and a link to the linestyles reference to https://github.com/matplotlib/matplotlib/blob/436a12abf2641483a933aabaded8a5df03e6081d/lib/matplotlib/sphinxext/roles.py#L126-L128","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2024-08-22T04:06:15.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/28745/matplotlib/issues/28745"}
| 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:bf567d6b-5ba0-a752-3bd6-1ebc74e91073 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A34E:6D3B3:4AF749:65411A:6A513553 |
| html-safe-nonce | e432ece73185e9564e2b794d7280215dd14f65dd674891db4b7d0696ee987290 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMzRFOjZEM0IzOjRBRjc0OTo2NTQxMUE6NkE1MTM1NTMiLCJ2aXNpdG9yX2lkIjoiMjAzNTg1MTMyNTEzNzMwMjg2NyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 11d86a57a16e6f9c5ed35480ad0f005b2c84982004f8d04ab6d4ff10a9d84f2b |
| hovercard-subject-tag | issue:2479717664 |
| 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/28745/issue_layout |
| twitter:image | https://opengraph.githubassets.com/4319311c64d1247d7187a262419e10cc6cddb3672da2e762679b068e04a837d0/matplotlib/matplotlib/issues/28745 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/4319311c64d1247d7187a262419e10cc6cddb3672da2e762679b068e04a837d0/matplotlib/matplotlib/issues/28745 |
| og:image:alt | Summary The manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using :mpltypes and _docstring.interp that we can then use to... |
| 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 | e840f405b2718e8f2d55aafa9ff27dbce17e29d0c253011d05ea0fea3c78baff |
| 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 | 4ae6027e8ba70c79dc08249bb6cdc1a09d788496 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width