Small improvements to legend's docstring. #6618
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The source looks a bit weirder, but the output of `pydoc pylab.legend` (or `plt.legend?` in IPython) is much nicer. I don't think numpydoc allows splitting the argument type information into two lines.
| @@ -372,8 +372,8 @@ def legend(self, *args, **kwargs): | |||
| The font properties of the legend. If None (default), the current | |||
| :data:`matplotlib.rcParams` will be used. | |||
|
|
|||
| fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium',\ | |||
There was a problem hiding this comment.
This was before your patch, but why is there a backslash at the end of that line?
There was a problem hiding this comment.
That removes the newline from the string, and is necessary so that Sphinx interprets it correctly.
There was a problem hiding this comment.
Makes sense. Thanks for the explanation!
|
I am going to ignore the coverage failure, considering this are only docstrings changes. |
|
backported to v2.x as f3ddb4e |
tacaswell
pushed a commit
that referenced
this pull request
Sep 16, 2016
Small improvements to legend's docstring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The source looks a bit weirder, but the output of
pydoc pylab.legend(or
plt.legend?in IPython) is much nicer. I don't think numpydocallows splitting the argument type information into two lines.