DOC Convert axes docstrings to numpydoc: #7205 #7389
Conversation
Convert set_xlim() docstring to numpydoc format.
Docstrings converted to numpydoc format.
There was a problem hiding this comment.
Hi @cfackler
Thanks a lot for this patch! This is a great improvement on our documentation.
I've added some comments, but I am fine merging as is.
My greatest concern is the fact that we seem to document several ways to do one action. I think as much as possible we should try to document one and only one way to do an action, as consistently as possible including in our response to SO questions.
| Returns | ||
| ------- | ||
| xlimits : tuple | ||
| Returns the current x-axis limits, reflecting any changes |
There was a problem hiding this comment.
I'd say "returns the new x-axis limits"
| set_ylim(top=1) # bottom unchanged | ||
| top : scalar, optional | ||
| The top ylim (default: None, which leaves the top limit | ||
| unchanged). The previous name `ymax` may be used instead. |
There was a problem hiding this comment.
I'd avoid mentioning the old API. As much as possible, we should advertise one and only way to do an action.
|
@NelleV Thanks for the suggestions. I agree and have updated the PR. |
|
Thanks @cfackler for the patch! The cherry-pick to v.2.x conficts and I don't have time to look into it tonight. |
DOC Convert axes docstrings to numpydoc: #7205 Conflicts: lib/matplotlib/axes/_base.py Minor text conflict in set_xlim docs
|
Backported to v2.x as 814fff5 |
I've converted several docstrings for the axes class to numpydoc format.