Skip to content

add docstring to ax.quiver #19566

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
Merged
merged 4 commits into from
Mar 2, 2021
Merged

add docstring to ax.quiver #19566

merged 4 commits into from
Mar 2, 2021

Conversation

K-Monty
Copy link
Contributor

@K-Monty K-Monty commented Feb 24, 2021

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@tacaswell
Copy link
Member

Ah, this PR replaces #19562. Copying my comment from that PR #19562 (comment):

@K-Monty Sorry for the slow response.

This did not work because in

matplotlib/lib/matplotlib/axes/_axes.py

Line 5100 in a510e32

quiver.__doc__ = mquiver.Quiver.quiver_doc
we set the fun.__doc__ attribute directly which overrides the one you added in this PR! If you are still interested in working on this you need to edit the string in mquiver.Quiver.quiver_doc

@tacaswell tacaswell added this to the v3.5.0 milestone Feb 25, 2021
@K-Monty
Copy link
Contributor Author

K-Monty commented Feb 26, 2021

@tacaswell Thanks for your feedback! I forgot to remove that line (quiver.doc = mquiver.Quiver.quiver_doc ), but my original intention was to separate the documentation in mquiver.Quiver.quiver_doc and the one I edited, so that they are independent of each other (mquiver.Quiver.quiver_doc will still be without 'return').
But I am not sure whether this is redundant, and I should just edit the documentation in mquiver.Quiver.quiver_doc, as you suggested?

@tacaswell
Copy link
Member

Please edit the existing string. I think we use it in multiple places and want to keep them in sync with each other.

@jklymak jklymak marked this pull request as draft February 26, 2021 21:10
timhoffm
timhoffm reviewed Feb 28, 2021
View reviewed changes
@QuLogic QuLogic marked this pull request as ready for review March 2, 2021 00:11
@QuLogic QuLogic merged commit 9c98ab0 into matplotlib:master Mar 2, 2021
@QuLogic
Copy link
Member

QuLogic commented Mar 2, 2021

Thanks @K-Monty! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.

@QuLogic QuLogic mentioned this pull request Mar 2, 2021
Closed
@K-Monty K-Monty deleted the K-Montys-branch branch March 2, 2021 08:47
@K-Monty
Copy link
Contributor Author

K-Monty commented Mar 2, 2021

Thanks a lot, guys! 😊

MihaiAnton pushed a commit to MihaiAnton/matplotlib that referenced this pull request Mar 8, 2021
@K-Monty @MihaiAnton
Add 'return' section in _quiver_doc (matplotlib#19566)
31b41f8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm left review comments

@QuLogic QuLogic QuLogic approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.
4 participants
@K-Monty @tacaswell @QuLogic @timhoffm