Skip to content

Make ArrowStyle docstrings numpydoc compatible #8342

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
dstansby opened this issue Mar 19, 2017 · 0 comments
Closed

Make ArrowStyle docstrings numpydoc compatible #8342

dstansby opened this issue Mar 19, 2017 · 0 comments
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation
Milestone
v2.0.1

Comments

@dstansby
Copy link
Member

The ArrowStyle docstrings should be converted into numpydoc-compatible strings. The current ones can be seen from here downwards: http://matplotlib.org/devdocs/api/patches_api.html?highlight=arrowstyle#matplotlib.patches.ArrowStyle.BarAB

See https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt for a guide to converting to a compatible docstring.
@dstansby dstansby added Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation new-contributor-friendly labels Mar 19, 2017
@patniharshit patniharshit mentioned this issue Mar 19, 2017
Merged
@QuLogic QuLogic added this to the 2.0.1 (next bug fix release) milestone Mar 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation
Projects
None yet
Milestone
v2.0.1
Development

No branches or pull requests
2 participants
@QuLogic @dstansby