Title: [Doc]: :rc: directive without defaults · Issue #32071 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: :rc: directive without defaults · Issue #32071 · matplotlib/matplotlib
X Title: [Doc]: :rc: directive without defaults · Issue #32071 · matplotlib/matplotlib
Description: Documentation Link No response Problem The :rc: directive always shows defaults. This can be undesired as in Suggested improvement We should have two directives, with and without listing the default. Historic context :rc: was primarily m...
Open Graph Description: Documentation Link No response Problem The :rc: directive always shows defaults. This can be undesired as in Suggested improvement We should have two directives, with and without listing the defaul...
X Description: Documentation Link No response Problem The :rc: directive always shows defaults. This can be undesired as in Suggested improvement We should have two directives, with and without listing the defaul...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/32071
X: @github
Domain: Github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: :rc: directive without defaults","articleBody":"### Documentation Link\n\n_No response_\n\n### Problem\n\nThe `:rc:` directive always shows defaults. This can be undesired as in\n\n\u003cimg width=\"685\" height=\"307\" alt=\"Image\" src=\"https://github.com/user-attachments/assets/4ec3c857-1453-4c54-a960-1937be1331bd\" /\u003e\n\n### Suggested improvement\n\nWe should have two directives, with and without listing the default.\n\n## Historic context\n\n`:rc:` was primarily motivated though parameter specifications such as \n\n\u003cimg width=\"542\" height=\"36\" alt=\"Image\" src=\"https://github.com/user-attachments/assets/deef849b-0634-4d01-921e-3034e11b2daf\" /\u003e\n\nwhere a default value regularly made sense.\n\nAlso back then, the link just went to a generic rcsetup page, not to individual parameters. Since we nowadays link to individual parameters, which state the default value. rc without stating the default is more practical as the default value can still be reached relatively easily through the link.\n\n## Proprosal\n\nThe major decision point is naming. I'm inclined to make `:rc:` the one without default value and add `:rcd:` for including the default. This is technically a breaking change of the `:rc:` directive, but I consider it mostly internal, and even if some external docs use it, the removal of the default should not be too disruptive.\n\nI want to keep the directive as short as possible so that it ideally fits in one line for type information in docstrings:\n```\n capsize : float, default: :rc:`errorbar.capsize`\n The length of the error bar caps in points.\n```\n`:rc-def:` or `:rc-default:` may already become too long for some parameters.\n\nAlso the alternative of keeping `:rc:` with default and adding `:rc-nodefault:` feels a bit wrong. To me it's not quite intuitive that `:rc:` should show the default by default.\n\nFeedback welcome.","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2026-07-19T01:54:42.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/32071/matplotlib/issues/32071"}
| 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:e43d9cbf-788a-16c9-f601-64fa3bd13420 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 945E:90F18:8AFC6D:BF10F5:6A628271 |
| html-safe-nonce | c11b03d20299e981a6ab59e8267420f44a601587cbd9c2ad96cf82a01ce28ff0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NDVFOjkwRjE4OjhBRkM2RDpCRjEwRjU6NkE2MjgyNzEiLCJ2aXNpdG9yX2lkIjoiMTQ5MjUzNTQwMjM5MzkyODMwNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | f68c73aa6c160613fe797db0cf948d8b5a010ce01a7bf0df6a2fbe7c8b8b59b5 |
| hovercard-subject-tag | issue:4920870411 |
| 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/32071/issue_layout |
| twitter:image | https://opengraph.githubassets.com/471873a6f678ff0b69352473a2d9add354156105c515bc03ba7b584a48140875/matplotlib/matplotlib/issues/32071 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/471873a6f678ff0b69352473a2d9add354156105c515bc03ba7b584a48140875/matplotlib/matplotlib/issues/32071 |
| og:image:alt | Documentation Link No response Problem The :rc: directive always shows defaults. This can be undesired as in Suggested improvement We should have two directives, with and without listing the defaul... |
| 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 | 834f5745a0905171956ffda6a4bdff25548a80194071fe4a15acaa5b349a60a0 |
| 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 | 4d79f1b99472a521fc5fb66e9fdc3ce742937dff |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width