Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Converting docstrings to numpydoc #7205

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
6 tasks done
NelleV opened this issue Sep 30, 2016 · 6 comments
Closed
6 tasks done

Converting docstrings to numpydoc #7205

NelleV opened this issue Sep 30, 2016 · 6 comments
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!

Comments

@NelleV
Copy link
Member

NelleV commented Sep 30, 2016 •
edited by tacaswell
Loading

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
@NelleV NelleV changed the title Some major functions of axes have not been moved to numpy-doc yet. Make a list of the important ones. Converting docstrings to numpydoc Sep 30, 2016
@NelleV NelleV added Documentation Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Machine Shop labels Sep 30, 2016
cfackler added a commit to cfackler/matplotlib that referenced this issue Nov 1, 2016
@cfackler
Convert docstring for set_xlim(), per issue matplotlib#7205
5c16159 
Convert set_xlim() docstring to numpydoc format.
@cfackler cfackler mentioned this issue Nov 1, 2016
Closed
cfackler added a commit to cfackler/matplotlib that referenced this issue Nov 2, 2016
@cfackler
Convert docstring for set_xlim(), per issue matplotlib#7205
6c601c0 
Convert set_xlim() docstring to numpydoc format.
cfackler added a commit to cfackler/matplotlib that referenced this issue Nov 2, 2016
@cfackler
Convert set_xlim and set_ylim docstrings; matplotlib#7205
6ef07e7 
Docstrings converted to numpydoc format.
cfackler added a commit to cfackler/matplotlib that referenced this issue Nov 3, 2016
@cfackler
Convert docstring for set_xlim(), per issue matplotlib#7205
a2b990d 
Convert set_xlim() docstring to numpydoc format.
cfackler added a commit to cfackler/matplotlib that referenced this issue Nov 3, 2016
@cfackler
Convert set_xlim and set_ylim docstrings; matplotlib#7205
49a8d83 
Docstrings converted to numpydoc format.
NelleV added a commit that referenced this issue Nov 7, 2016
@NelleV
Merge pull request #7389 from cfackler/update-axes-docstrings-fixed
1d4244f 
DOC Convert axes docstrings to numpydoc: #7205
tacaswell pushed a commit that referenced this issue Nov 8, 2016
@NelleV @tacaswell
Merge pull request #7389 from cfackler/update-axes-docstrings-fixed
814fff5 
DOC Convert axes docstrings to numpydoc: #7205
Conflicts:
	lib/matplotlib/axes/_base.py
	  Minor text conflict in set_xlim docs
bcongdon pushed a commit to bcongdon/matplotlib that referenced this issue Nov 8, 2016
@cfackler @bcongdon
Convert docstring for set_xlim(), per issue matplotlib#7205
1111117 
Convert set_xlim() docstring to numpydoc format.
bcongdon pushed a commit to bcongdon/matplotlib that referenced this issue Nov 8, 2016
@cfackler @bcongdon
Convert set_xlim and set_ylim docstrings; matplotlib#7205
2c8324f 
Docstrings converted to numpydoc format.
bcongdon pushed a commit to bcongdon/matplotlib that referenced this issue Nov 8, 2016
@cfackler @bcongdon
Convert docstring for set_xlim(), per issue matplotlib#7205
4703e09 
Convert set_xlim() docstring to numpydoc format.
bcongdon pushed a commit to bcongdon/matplotlib that referenced this issue Nov 8, 2016
@cfackler @bcongdon
Convert set_xlim and set_ylim docstrings; matplotlib#7205
7a7e4ea 
Docstrings converted to numpydoc format.
@sirlittle sirlittle mentioned this issue Nov 15, 2016
Merged
@QuLogic QuLogic mentioned this issue Nov 30, 2016
Closed
5 tasks
@QuLogic
Copy link
Member

QuLogic commented Nov 30, 2016

#7535 points out that finishing this and putting in return types will help with autocompletion in Jedi.

@tacaswell tacaswell mentioned this issue Dec 29, 2016
Closed
@Ruin0x11 Ruin0x11 mentioned this issue Jul 16, 2017
Merged
@anntzer anntzer mentioned this issue Oct 2, 2017
Merged
1 task
@melvyniandrag
Copy link
Contributor

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
Copy link
Contributor

anntzer commented Oct 11, 2017

I think the remaining work is in #9262.

@melvyniandrag
Copy link
Contributor

Thanks for the reply. Looks like you finished it!

@tacaswell tacaswell added the Good first issue Open a pull request against these issues if there are no active ones! label Oct 16, 2017
@dopplershift
Copy link
Contributor

With #9262 merged, should we close this?

@timhoffm timhoffm mentioned this issue Nov 14, 2017
Merged
@timhoffm timhoffm mentioned this issue Jan 3, 2018
Closed
79 tasks
@tacaswell
Copy link
Member

These methods all appear to have numpydoc docstrings now.

Discovered this while looking at issues with @eaishwa

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 Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@NelleV @tacaswell @dopplershift @QuLogic @anntzer @dstansby @melvyniandrag