Title: [Doc]: Documentation of rc parameters could be improved · Issue #23531 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Documentation of rc parameters could be improved · Issue #23531 · matplotlib/matplotlib
X Title: [Doc]: Documentation of rc parameters could be improved · Issue #23531 · matplotlib/matplotlib
Description: Documentation Link https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file Problem As far as I am aware of, the only documentation of "what can be changed through rc paramters" is a the literal...
Open Graph Description: Documentation Link https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file Problem As far as I am aware of, the only documentation of "what can be change...
X Description: Documentation Link https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file Problem As far as I am aware of, the only documentation of "what can be c...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/23531
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Documentation of rc parameters could be improved","articleBody":"### Documentation Link\n\nhttps://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file\n\n### Problem\n\nAs far as I am aware of, the only documentation of \"what can be changed through rc paramters\" is a the literal-included default matplotlibrc file, which has comments for various options. This is a very cumbersome way to present information in 2022.\r\n\r\nThere's also no direct link for third-party packages that expose an interface for setting rc parameters and want to link to the source documentation. You could hardcode the url including the anchor, but (1) that will break the next time matplotlib reorganizes things, and (2) if you link directly to the \"default matplotlibrc file\", there's no context for what people are looking at and it's confusing why the information is being presented the way that it is.\n\n### Suggested improvement\n\nRendering this information as regular html with semantic markup would be a significant improvement. Specific short-term benefits would include:\r\n\r\n- Visual differentiation of headers, parameters, defaults, and descriptions\r\n- Site navigation to various sections (it can be hard to find what you're looking for: the file is 767 lines long, and the groups are not in alphabetical order)\r\n\r\nAdditionally, this would make it possible to explore more complex interfaces, like having a filtering functionality to show all parameters with a given substring (\"color\") in their name.\r\n\r\nTo address the second issue, I would suggest separating the specific parameter documentation from the more general \"how you customize matplotlib\" page, with it discussion of various *methods* for changing those parameters (style sheets, matplotlibrc file, etc.).\r\n\r\nI appreciate that the default matplotlibrc file is currently the source of truth for this information and that it's not properly structured in a way that would facilitate extracting the information, so this wouldn't be trivial. But I think it would help a lot.","author":{"url":"https://github.com/mwaskom","@type":"Person","name":"mwaskom"},"datePublished":"2022-08-01T11:22:05.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":5},"url":"https://github.com/23531/matplotlib/issues/23531"}
| 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:e538363a-b75e-984a-a64e-1704afc4c92e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | EB0E:1C38BA:1AB959B:237634E:6A51D409 |
| html-safe-nonce | b2bffe0985e1e4dbd6a2babcde026947d3c07741e0b3a82204aece5b37fa3284 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFQjBFOjFDMzhCQToxQUI5NTlCOjIzNzYzNEU6NkE1MUQ0MDkiLCJ2aXNpdG9yX2lkIjoiNjY3MTI0MjAyODI4MDU2Njc5MyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | cb105aa6c5749a98e0fd696a9f613eda281fe15ba8287504a6c69c29f19f3112 |
| hovercard-subject-tag | issue:1324259368 |
| 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/23531/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2a649d3fa192202b48b77d5e41e70b4e16f4687f9a13603988f96ced1d9974d2/matplotlib/matplotlib/issues/23531 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2a649d3fa192202b48b77d5e41e70b4e16f4687f9a13603988f96ced1d9974d2/matplotlib/matplotlib/issues/23531 |
| og:image:alt | Documentation Link https://matplotlib.org/stable/tutorials/introductory/customizing.html#the-default-matplotlibrc-file Problem As far as I am aware of, the only documentation of "what can be change... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mwaskom |
| 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