Skip to content

Fix markup in plt.subplots docstring. #8489

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.

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

Merged
merged 1 commit into from
Apr 16, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 15, 2017

(does not apply to Figure.subplots, which does not take fig_kw).

closes #8078
see http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html for markup (numpydoc itself does not have an example for that but I hope that it works too...)

@QuLogic
Copy link
Member

QuLogic commented Apr 15, 2017

We do it with **kwargs, so it should work. Maybe also update the description to remove the dict type, which isn't really true?

@anntzer anntzer force-pushed the subplots-docstring-markup branch from b4d0959 to ab347f2 Compare April 15, 2017 06:43
@anntzer
Copy link
Contributor Author

anntzer commented Apr 15, 2017

sounds reasonable, fixed

Dict with keywords passed to the :func:`figure` call. Note that all
keywords not recognized above will be automatically included here.
**fig_kw :
All additional keywords arguments are passed to the :func:`figure`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keyword

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup

(does not apply to Figure.subplots, which does not take fig_kw).
@anntzer anntzer force-pushed the subplots-docstring-markup branch from ab347f2 to d57ebc9 Compare April 15, 2017 06:47
@QuLogic QuLogic changed the title Fix markup in plt.subplots docstring. [MRG+1] Fix markup in plt.subplots docstring. Apr 15, 2017
@tacaswell tacaswell merged commit cefeb93 into matplotlib:master Apr 16, 2017
tacaswell added a commit that referenced this pull request Apr 16, 2017
DOC: Fix markup in plt.subplots docstring.
@anntzer anntzer deleted the subplots-docstring-markup branch April 16, 2017 22:42
@QuLogic QuLogic changed the title [MRG+1] Fix markup in plt.subplots docstring. Fix markup in plt.subplots docstring. Apr 17, 2017
@QuLogic QuLogic added this to the 2.1 (next point release) milestone Apr 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plt.subplots crashes when handed fig_kw argument
3 participants