Skip to content

Quiver docs don't have a return section #19464

Closed
@ianhi

Description

@ianhi

Problem

The doc(string) for ax.quiver doesn't include a Returns section that shows that it returns a matplotlib.quiver.Quiver
https://matplotlib.org/devdocs/api/_as_gen/matplotlib.pyplot.quiver.html

This makes it tricky to click through from that page to see the methods of this object.

This is because the axes quiver method takes a straight copy of the quiver init docstring.

quiver.__doc__ = mquiver.Quiver.quiver_doc

Suggested Improvement

add a Returns section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationGood first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions