Tidied up some of the documentation. #1918

Merged
merged 4 commits into from Apr 26, 2013

Projects

None yet

3 participants

@pelson
Member
pelson commented Apr 18, 2013

No description provided.

@NelleV NelleV and 1 other commented on an outdated diff Apr 18, 2013
lib/matplotlib/colors.py
"""
def __init__(self, name, N=256):
"""
- Public class attributes:
- :attr:`N` : number of rgb quantization levels
- :attr:`name` : name of colormap
+ Parameters
@NelleV
NelleV Apr 18, 2013 collaborator

For numpydoc + sphinx to render properly, you need to underline parameters (and all subtitles) with '-----'

@pelson
pelson Apr 18, 2013 Matplotlib Developers member

Hmmm, yes, but when I do that, I get a sphinx build failure (I was following the example here: https://github.com/numpy/numpy/blob/master/doc/example.py). I'd sooner not hold up the PR trying to figure out the problem (but I'd be happy to look into it in a follow on issue, if that is ok with you @NelleV?)

@NelleV
NelleV Apr 18, 2013 collaborator

Yes, sure. This PR is already a huge step forward !

@pelson
pelson Apr 18, 2013 Matplotlib Developers member

I must have been mistaken (perhaps I typed Parameters: instead of Parameters) because now it works. I've updated the PR.

@NelleV
Collaborator
NelleV commented Apr 18, 2013

Nice work ! The examples look much better, and I really appreciate the changes from pylab import * to the "proper" use of the pyplot submodule.

I've only skimmed through the patch. I've notice some of the changes to completely follow numpydoc's convention:
all subtitles should be underline with '-':

  • Parameters
  • Returns
  • Other parameters
  • Raises
  • See Also
  • Notes
  • References
  • Examples

(and they also have to be in that order)

@pelson
Member
pelson commented Apr 18, 2013

(and they also have to be in that order)

Ah, maybe that is the incantation that was the problem. I'll go through and see if it does the trick. Thanks @NelleV.

@pelson pelson commented on an outdated diff Apr 18, 2013
lib/matplotlib/pyplot.py
@@ -98,10 +98,10 @@ def _backend_selection():
_backend_mod, new_figure_manager, draw_if_interactive, _show = pylab_setup()
@docstring.copy_dedent(Artist.findobj)
-def findobj(o=None, match=None):
+def findobj(o=None, match=None, include_self=True):
@pelson
pelson Apr 18, 2013 Matplotlib Developers member

This was a bug (or at least, the "include_self" keyword was documented, but would not work).

@mdboom
Member
mdboom commented Apr 18, 2013

@pelson: Looks good! Can't keep up with you.

This will probably create some additional merge conflicts for #1623, but c'est la vie.

@pelson
Member
pelson commented Apr 18, 2013

@pelson: Looks good! Can't keep up with you.
This will probably create some additional merge conflicts for #1623, but c'est la vie.

Agreed. I'm prepared to help out @tonysyu with any conflicts (and the review in general), so please go ahead and merge if you're happy and we can deal with those issues downstream.

@NelleV
Collaborator
NelleV commented Apr 19, 2013

LGTM
👍 for merge !

@pelson
Member
pelson commented Apr 26, 2013

I've rebased this after merging @tonysyu's PR. It'd be good to get this merged soon-ish as I have other changes I'd like to make to the documentation (hopefully in smaller PRs).

@mdboom mdboom merged commit 6dd6a75 into matplotlib:master Apr 26, 2013

1 check passed

Details default The Travis build passed
@NelleV
Collaborator
NelleV commented Apr 26, 2013

@pelson We lost the summary of all methods in a class:http://cbio.ensmp.fr/~nvaroquaux/matplotlib/doc/api/axes_api.html
Was that on purpose?

@mdboom
Member
mdboom commented Apr 26, 2013

@NelleV: Sorry, my bad for not confirming that before hitting the merge button. It would be nice to keep that summary. Maybe @pelson has an idea about why it disappeared.

@NelleV
Collaborator
NelleV commented Apr 26, 2013

I'm not even sure it's from this PR; I just noticed it disappeared.

I really like the new content: http://cbio.ensmp.fr/~nvaroquaux/matplotlib/doc/contents.html

@NelleV
Collaborator
NelleV commented Apr 26, 2013

Unfortunately, it is the numpydoc_show_class_members = False, which fixes two tickets (#1837 and #1896).
I think we'll have to dig into numpydoc to have both the nice summary and the fix of those two tickets.

@tonysyu tonysyu added a commit to tonysyu/matplotlib that referenced this pull request May 5, 2013
@tonysyu tonysyu Fix `backend_driver.py`
A couple of files were removed in PR #1918, but were accidentally re-added to `backend_driver.py` by PR #1924.
42f3f00
@tonysyu tonysyu referenced this pull request May 5, 2013
Merged

Fix `backend_driver.py` #1977

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment