Title: [Doc]: Data parameter description is not always replaced · Issue #21135 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Data parameter description is not always replaced · Issue #21135 · matplotlib/matplotlib
X Title: [Doc]: Data parameter description is not always replaced · Issue #21135 · matplotlib/matplotlib
Description: Documentation Link https://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER Problem Generating the data parameter description does not work properly for a number of functions This search should be empty: https://matplo...
Open Graph Description: Documentation Link https://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER Problem Generating the data parameter description does not work properly for a number of functions Thi...
X Description: Documentation Link https://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER Problem Generating the data parameter description does not work properly for a number of functions Thi...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/21135
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Data parameter description is not always replaced","articleBody":"### Documentation Link\n\nhttps://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER\n\n### Problem\n\nGenerating the data parameter description does not work properly for a number of functions\r\n\r\nThis search should be empty:\r\nhttps://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER\r\n\r\nThe replacement of this placeholder is done through the `@_preprocess_data` decorator. This does not work if\r\n\r\n- the function accepts data but does not use the decorator, because the resolution is deferrd; e.g. in `semilogx`\r\n- or if the docstring is added to the function afterwards, e.g. in `quiver`\r\n\r\n\n\n### Suggested improvement\n\nReformatting the docstring should be extracted into an isolated function(s)\r\n\r\n```\r\n@fill_data_parameter_placeholder\r\ndef semilogx():\r\n```\r\n\r\nand\r\n```\r\ndef quiver():\r\n ....\r\nquiver.__doc__ = fill_data_parameter_placeholder(QUIVER_DOC)\r\n```\n\n### Matplotlib Version\n\n3.5.x\n\n### Matplotlib documentation version\n\n3.5.x","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2021-09-19T21:56:12.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/21135/matplotlib/issues/21135"}
| 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:a3d9c0d4-8e3e-36b3-a68e-9b1ca1a82a42 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C412:24AA1D:8B99A:B83DB:6A52E9BD |
| html-safe-nonce | 81c0f2c565a0575ad69a0b75a3e7794ecf8ce76ba90f044c7ad6977e47891e89 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDNDEyOjI0QUExRDo4Qjk5QTpCODNEQjo2QTUyRTlCRCIsInZpc2l0b3JfaWQiOiIyMTk3NTY5MjM5MTA3NDMwODQ1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 2cd2e996aa5864a25bacedcea1c75ca930b44d4c7318be6255e4f5d824733cb8 |
| hovercard-subject-tag | issue:1000429672 |
| 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/21135/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2e8ff5736e9245f8745ad37e69af496eef3fb79361b740781d8f3c96f3e1b91c/matplotlib/matplotlib/issues/21135 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2e8ff5736e9245f8745ad37e69af496eef3fb79361b740781d8f3c96f3e1b91c/matplotlib/matplotlib/issues/21135 |
| og:image:alt | Documentation Link https://matplotlib.org/devdocs/search.html?q=++++DATA_PARAMETER_PLACEHOLDER Problem Generating the data parameter description does not work properly for a number of functions Thi... |
| 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 | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width