Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Tidied up some of the documentation.#1918
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| Public class attributes: | ||
| :attr:`N` : number of rgb quantization levels | ||
| :attr:`name` : name of colormap | ||
| Parameters |
There was a problem hiding this comment.
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 '-----'
There was a problem hiding this comment.
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?)
There was a problem hiding this comment.
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 !
There was a problem hiding this comment.
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 typedParameters: instead ofParameters) because now it works. I've updated the PR.
Nice work ! The examples look much better, and I really appreciate the changes I've only skimmed through the patch. I've notice some of the changes to completely follow numpydoc's convention:
(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. |
| @@ -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): | |||
There was a problem hiding this comment.
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).
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. |
LGTM |
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). |
Tidied up some of the documentation.
@pelson We lost the summary of all methods in a class:http://cbio.ensmp.fr/~nvaroquaux/matplotlib/doc/api/axes_api.html |
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 |
A couple of files were removed in PRmatplotlib#1918, but were accidentally re-added to `backend_driver.py` by PRmatplotlib#1924.
No description provided.