Repository navigation
Converting docstrings to numpydoc #7205
Description
Some of the quite well used methodes of the Axes object haven't been ported to numpy doc yet.
This ticket aims at listing those, and slowly moving those functions to numpy doc.
- set_xticklabels, set_yticklabels (missing documentation of some args)
- Figure.add_subplot, Figure.add_axes
- twinx, twiny
- set_xlim, set_ylim
- set_xlim, set_ylim
- set_xscale, set_yscale
Contributors, feel free to update this list as need be!
Here is some documentation: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
Activity
[-]Some major functions of axes have not been moved to numpy-doc yet. Make a list of the important ones.[/-][+]Converting docstrings to numpydoc[/+]Convert docstring for set_xlim(), per issue matplotlib#7205
Convert docstring for set_xlim(), per issue matplotlib#7205
Convert set_xlim and set_ylim docstrings; matplotlib#7205
Convert docstring for set_xlim(), per issue matplotlib#7205
Convert set_xlim and set_ylim docstrings; matplotlib#7205
Merge pull request #7389 from cfackler/update-axes-docstrings-fixed
Merge pull request #7389 from cfackler/update-axes-docstrings-fixed
Convert docstring for set_xlim(), per issue matplotlib#7205
Convert set_xlim and set_ylim docstrings; matplotlib#7205
Convert docstring for set_xlim(), per issue matplotlib#7205
Convert set_xlim and set_ylim docstrings; matplotlib#7205
QuLogic commentedon Nov 30, 2016
#7535 points out that finishing this and putting in return types will help with autocompletion in Jedi.
melvyniandrag commentedon Oct 11, 2017
Just passing by looking for some stuff to do this evening. In the initial post of this thread there are two unchecked boxes, but I just looked at the docstrings for those functions and the format looks consistent with the format of the docstrings for the functions corresponding to the checked boxes. Should this be closed?
anntzer commentedon Oct 11, 2017
I think the remaining work is in #9262.
melvyniandrag commentedon Oct 11, 2017
Thanks for the reply. Looks like you finished it!
dopplershift commentedon Oct 30, 2017
With #9262 merged, should we close this?
tacaswell commentedon Oct 21, 2018
These methods all appear to have numpydoc docstrings now.
Discovered this while looking at issues with @eaishwa