[Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation #24150
Comments
|
There is often a Bases section which shows the parent classes, but this seems to be missing from the animation classes. In TimedAnimation this has been solved by explicitly mentioning the parent class https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.TimedAnimation.html While, of course, the best solution is to get the inheritance documentation working, a simple step to partly remedy this would be to do something similar. |
|
I see. For now, I think we should specify that I can try to investigate how we can get inheritance documentation working |
|
Maybe we just want to add https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html |
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
saveis very incomplete. This is becausesaveis a method inherited from the parentanimation.Animation.Suggested improvement
I think it would be extremely helpful to have a link to the parent's
savemethod fromanimation.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 ofFuncAnimation, and follow up its inheritance tree to find wheresavewas defined, then either read the docstring or find the corresponding method in the online documentation.To 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.
The text was updated successfully, but these errors were encountered: