Skip to content

Tidied up some of the documentation.#1918

Merged
mdboom merged 4 commits into
matplotlib:masterfrom
pelson:updated_v1p3docs
Apr 26, 2013
Merged

Tidied up some of the documentation.#1918
mdboom merged 4 commits into
matplotlib:masterfrom
pelson:updated_v1p3docs

Conversation

@pelson
Copy link
Copy Markdown
Member

@pelson pelson commented Apr 18, 2013

No description provided.

NelleV
NelleV reviewed Apr 18, 2013
View reviewed changes
Comment thread lib/matplotlib/colors.py Outdated
Copy link
Copy Markdown
Member

@NelleV NelleV Apr 18, 2013

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

@pelson pelson Apr 18, 2013

Choose a reason for hiding this comment

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

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?)

Copy link
Copy Markdown
Member

@NelleV NelleV Apr 18, 2013

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member Author

@pelson pelson Apr 18, 2013

Choose a reason for hiding this comment

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

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

@NelleV
Copy link
Copy Markdown
Member

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
Copy link
Copy Markdown
Member Author

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 reviewed Apr 18, 2013
View reviewed changes
Comment thread lib/matplotlib/pyplot.py Outdated
Copy link
Copy Markdown
Member Author

@pelson pelson Apr 18, 2013

Choose a reason for hiding this comment

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

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

@mdboom
Copy link
Copy Markdown
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
Copy link
Copy Markdown
Member Author

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
Copy link
Copy Markdown
Member

NelleV commented Apr 19, 2013

LGTM
👍 for merge !

@mdboom mdboom mentioned this pull request Apr 19, 2013
Merged
@pelson
Copy link
Copy Markdown
Member Author

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 added a commit that referenced this pull request Apr 26, 2013
@mdboom
Merge pull request #1918 from pelson/updated_v1p3docs
6dd6a75 
Tidied up some of the documentation.
@mdboom mdboom merged commit 6dd6a75 into matplotlib:master Apr 26, 2013
@NelleV
Copy link
Copy Markdown
Member

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
Copy link
Copy Markdown
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
Copy link
Copy Markdown
Member

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
Copy link
Copy Markdown
Member

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.

@takluyver takluyver mentioned this pull request Apr 27, 2013
Merged
@mdboom mdboom mentioned this pull request May 3, 2013
Closed
tonysyu added a commit to tonysyu/matplotlib that referenced this pull request May 5, 2013
@tonysyu
Fix backend_driver.py
42f3f00 
A couple of files were removed in PR matplotlib#1918, but were accidentally re-added to `backend_driver.py` by PR matplotlib#1924.
@tonysyu tonysyu mentioned this pull request May 5, 2013
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pelson @NelleV @mdboom