Less ACCEPTS, more numpydoc. #12229
Merged
Less ACCEPTS, more numpydoc. #12229
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
anntzer
commented
Sep 23, 2018
| instances. Use *kwarg* *minor=True* to select minor ticks. | ||
| All other kwargs are used to update the text object properties. | ||
| As for get_ticklabels, label1 (left or bottom) is | ||
| affected for a given tick only if its label1On attribute |
There was a problem hiding this comment.
This is simply not true: we update all ticks regardless of visibility.
timhoffm
reviewed
Sep 23, 2018
lib/matplotlib/axis.py
Outdated
| labels. | ||
| minor : bool | ||
| If True, set minor ticks instead of major ticks. | ||
| **kwargs : |
There was a problem hiding this comment.
No colon needed if you don't specify a type.
lib/matplotlib/axis.py
Outdated
| """ | ||
| Returns | ||
| ------- | ||
| List of visible `Text`\s. For each tick, includes ``tick.label1`` if |
There was a problem hiding this comment.
numpydoc requires Returns to be formatted like Parameters. Do something like
Returns
-------
labels
List of visible `Text`\s. For each tick, includes ``tick.label1`` if
it is visible, then ``tick.label2`` if it is visible, in that order.
|
comments handled |
ef91628 to
c8bc106
Compare
timhoffm
approved these changes
Sep 23, 2018
jklymak
reviewed
Sep 23, 2018
lib/matplotlib/artist.py
Outdated
| match = re.search("(?m)^ *{} : (.+)".format(param_name), docstring) | ||
| # We could set the number of * based on whether the parameter is a | ||
| # var(kw)args but it's not really worth the complexity. | ||
| match = re.search("(?m)^ *\*{{0,2}}{} : (.+)".format(param_name), |
There was a problem hiding this comment.
The change is \*{{0,2}} to support parsing
*margins : float, optional
and potentially also **kwargs : type (though I don't know if we have such a case. See also the added test.
There was a problem hiding this comment.
I just realized that this can never be **kwargs (because the setter passes the argument positionally), so I replaced it to only support a single *.
c8bc106 to
50fc4c8
Compare
jklymak
approved these changes
Sep 24, 2018
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.
PR Summary
All's in the title.
PR Checklist