Title: [Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation · Issue #24150 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation · Issue #24150 · matplotlib/matplotlib
X Title: [Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation · Issue #24150 · matplotlib/matplotlib
Description: Documentation Link https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html Problem In https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html, the documentation of save is very incomple...
Open Graph Description: Documentation Link https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html Problem In https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html, th...
X Description: Documentation Link https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html Problem In https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html, th...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/24150
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation","articleBody":"### Documentation Link\n\nhttps://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html\n\n### Problem\n\nIn https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html, the documentation of `save` is very incomplete. This is because `save` is a method inherited from the parent [`animation.Animation`](https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.save).\r\n\n\n### Suggested improvement\n\nI think it would be extremely helpful to have a link to the parent's `save` method from `animation.FuncAnimation`'s documentation base, as currently I don't think there is a straightforward way to find that documentation. I actually had to go to the source code of `FuncAnimation`, and follow up its inheritance tree to find where `save` was defined, then either read the docstring or find the corresponding method in the online documentation. \r\n\r\nTo extend this further - it would be helpful for all subclasses to have proper links to a parent method's documentation when the method isn't modified in the child. ","author":{"url":"https://github.com/kwsp","@type":"Person","name":"kwsp"},"datePublished":"2022-10-12T22:28:29.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/24150/matplotlib/issues/24150"}
| 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:8e2f9d7f-b0a0-14bd-01ad-43e13f3d01c6 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BC0A:1960:6C324AA:98F12A5:6A50CC7C |
| html-safe-nonce | 85325ee4c1a7a0f09c7bb928197bf68b30fd60b0794bd7bbddb4bd637cd1878a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQzBBOjE5NjA6NkMzMjRBQTo5OEYxMkE1OjZBNTBDQzdDIiwidmlzaXRvcl9pZCI6IjkxNzk0NjUxNjM0OTcwNjU1OTYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | e3a3d45d33262db109d9bf1bf674d12a2338a77305589a400c52bea0d51b4440 |
| hovercard-subject-tag | issue:1406877338 |
| 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/24150/issue_layout |
| twitter:image | https://opengraph.githubassets.com/eaf1fc3cd18afbf988cf730bf9d85c6ba4d186cccc39890933ada0afe90650c3/matplotlib/matplotlib/issues/24150 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/eaf1fc3cd18afbf988cf730bf9d85c6ba4d186cccc39890933ada0afe90650c3/matplotlib/matplotlib/issues/24150 |
| og:image:alt | Documentation Link https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html Problem In https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.FuncAnimation.html, th... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | kwsp |
| hostname | github.com |
| expected-hostname | github.com |
| None | 72b13e0e8d0319acdd27a145cfe73f4f06c791713d0ac4690e41fb68ad28cac0 |
| 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 | 08e79d53fc070870d5b168356afebb1e286a2ffe |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width