Title: [Doc]: Better document Axes.transData and other transXYZ attributes · Issue #25220 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Better document Axes.transData and other transXYZ attributes · Issue #25220 · matplotlib/matplotlib
X Title: [Doc]: Better document Axes.transData and other transXYZ attributes · Issue #25220 · matplotlib/matplotlib
Description: Documentation Link No response Problem It's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable: People search for it on Github: https://github....
Open Graph Description: Documentation Link No response Problem It's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable: People ...
X Description: Documentation Link No response Problem It's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable: Peo...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/25220
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Better document Axes.transData and other transXYZ attributes","articleBody":"### Documentation Link\n\n_No response_\n\n### Problem\n\nIt's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable:\r\n\r\n- People search for it on Github:\r\n https://github.com/matplotlib/matplotlib/graphs/traffic\r\n \r\n- Search does not yield useful results: https://matplotlib.org/stable/search.html?q=transData\r\n\r\nProblem: `transData` and the likes are only attributes set in a [private function]/(https://github.com/matplotlib/matplotlib/blob/39070aeaab732eca1b5b7f7b478fa8b72dab8507/lib/matplotlib/axes/_base.py#L910)\r\nAs such, they do not have a docstring and do not appear in the API documentation.\r\n\r\n\r\n\r\n\r\n\n\n### Suggested improvement\n\nAction: Find out, how to make this available in the API docs at https://github.com/matplotlib/matplotlib/blob/main/doc/api/axes_api.rst\r\n\r\nWorth checking:\r\n- https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute\r\n- or manually: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-py-attribute\r\n\r\nAlternative: Turn the `trans*` attributes into properties. They can be documented properly and have the advantage of being read-only. This is a slight performance cost, but should be negligible compared to any action involving the transforms.","author":{"url":"https://github.com/timhoffm","@type":"Person","name":"timhoffm"},"datePublished":"2023-02-15T10:04:48.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":12},"url":"https://github.com/25220/matplotlib/issues/25220"}
| 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:6b7e5ccc-0ee7-8bf1-d7eb-a8d151b0310f |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E046:12D39C:14E785:1B8BCF:6A5271D4 |
| html-safe-nonce | 6753eea6962f8399e66683f139077dd8a29a9872a9a85c598c629994a1828478 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMDQ2OjEyRDM5QzoxNEU3ODU6MUI4QkNGOjZBNTI3MUQ0IiwidmlzaXRvcl9pZCI6Ijg4OTg4MDQwOTU5NzQwMTEzNDgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 4ef9004db5db3f9270eb8a41dd736c745c990dbe62fe317a7a1860a5189c6185 |
| hovercard-subject-tag | issue:1585569371 |
| 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/25220/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d981162a5b1750eb0ac53f8dae90169a84503d143f8ab9cd04f7f0dba9061a8f/matplotlib/matplotlib/issues/25220 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d981162a5b1750eb0ac53f8dae90169a84503d143f8ab9cd04f7f0dba9061a8f/matplotlib/matplotlib/issues/25220 |
| og:image:alt | Documentation Link No response Problem It's documented in the tutorial https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html#data-coordinates, but not very discoverable: People ... |
| 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