Skip to content

Quiver docs don't have a return section #19464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
ianhi opened this issue Feb 5, 2021 · 4 comments
Closed

Quiver docs don't have a return section #19464

ianhi opened this issue Feb 5, 2021 · 4 comments
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Milestone
v3.5.0

Comments

@ianhi
Copy link
Contributor

ianhi commented Feb 5, 2021

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.

matplotlib/lib/matplotlib/axes/_axes.py

Line 5099 in 4da4cf9

quiver.__doc__ = mquiver.Quiver.quiver_doc

Suggested Improvement

add a Returns section.
@aryanxk02
Copy link

Hey there @ianhi I am new to open source contribution. I want to solve this issue. Would be helpful if you guide me through this. THAN YOU!

@jklymak
Copy link
Member

jklymak commented Feb 10, 2021

@aryanxk02 Guidance for how to contribute is at: https://matplotlib.org/stable/devel/index.html If you have a solution to the above, you post a pull request.

@dstansby dstansby added the Good first issue Open a pull request against these issues if there are no active ones! label Feb 17, 2021
@K-Monty
Copy link
Contributor

K-Monty commented Feb 23, 2021

Hi, I am also new to open source contribution. I have made a first-attempt on this issue: #19562 (comment), but it doesn't seem to work. Any guidance(s) are welcomed!

@QuLogic
Copy link
Member

QuLogic commented Mar 2, 2021

Closed by #19566.

@QuLogic QuLogic closed this as completed Mar 2, 2021
@QuLogic QuLogic added this to the v3.5.0 milestone Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
v3.5.0
Development

No branches or pull requests
6 participants
@QuLogic @jklymak @dstansby @ianhi @K-Monty @aryanxk02