Skip to content

[Doc]: Improve animation.FuncAnimation.save - link parent methods in child's method documentation #24150

Closed
@kwsp

Description

@kwsp

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 incomplete. This is because save is a method inherited from the parent animation.Animation.

Suggested improvement

I 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.

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions