Clean up units.py #10370
Merged
Clean up units.py #10370
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
timhoffm
reviewed
Feb 3, 2018
lib/matplotlib/units.py
Outdated
| If any of the above are None, the axis will simply use the default | ||
| Parameters | ||
| ---------- | ||
| majloc, minloc : |
There was a problem hiding this comment.
„The colon must be omitted if the type is absent.“ https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections
Also in the following lines.
lib/matplotlib/units.py
Outdated
| """ | ||
| @staticmethod | ||
| def axisinfo(unit, axis): | ||
| 'return an units.AxisInfo instance for axis with the specified units' | ||
| ''' | ||
| Return an `~units.AxisInfo` instance for axis with the specified units. |
lib/matplotlib/units.py
Outdated
| """ | ||
| def __init__(self): | ||
| dict.__init__(self) | ||
| self._cached = {} | ||
|
|
||
| def get_converter(self, x): | ||
| 'get the converter interface instance for x, or None' | ||
| 'Get the converter interface instance for *x*, or ``None``.' |
lib/matplotlib/units.py
Outdated
| return None | ||
|
|
||
| @staticmethod | ||
| def default_units(x, axis): | ||
| 'return the default unit for x or None for the given axis' | ||
| 'Return the default unit for *x* or ``None`` for the given axis.' |
timhoffm
reviewed
Feb 3, 2018
lib/matplotlib/units.py
Outdated
| """ | ||
| @staticmethod | ||
| def axisinfo(unit, axis): | ||
| 'return an units.AxisInfo instance for axis with the specified units' | ||
| ''' |
There was a problem hiding this comment.
Tripple double quotes (PEP 257)
phobson
approved these changes
Feb 6, 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.
I don't actually know what some of the docstrings mean, but I figure fixing the grammar is probably a good thing to do anyway.