Shorten some docstrings. #12625
Merged
Shorten some docstrings. #12625
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
approved these changes
Oct 26, 2018
lib/matplotlib/axes/_base.py
Outdated
| :class:`~matplotlib.ticker.ScalarFormatter` is not the | ||
| :class:`~matplotlib.ticker.Formatter` being used, an | ||
| If the method is called when the `~matplotlib.ticker.ScalarFormatter` | ||
| is not the `~matplotlib.ticker.Formatter` being used, an | ||
| :exc:`AttributeError` will be raised. |
There was a problem hiding this comment.
prefix can be omitted as well.
lib/matplotlib/axes/_base.py
Outdated
| @@ -3680,7 +3634,7 @@ def xaxis_date(self, tz=None): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| tz : string or :class:`tzinfo` instance, optional | |||
| tz : string or `tzinfo` instance, optional | |||
| Timezone string or timezone. Defaults to rc value. | |||
lib/matplotlib/axes/_base.py
Outdated
| @@ -3693,7 +3647,7 @@ def yaxis_date(self, tz=None): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| tz : string or :class:`tzinfo` instance, optional | |||
| tz : string or `tzinfo` instance, optional | |||
| Timezone string or timezone. Defaults to rc value. | |||
- Remove the explicit :class: annotation (which isn't necessary). - Make docstrings of all Axes.add_foo methods consistent among themselves: a) having a separate Parameters/Returns section for each of them seems completely overkill; b) most (all?) of them set the clip_path and the transform on the added artist, so the snippet to that effect that was present in add_patch should be added to either all or none of the methods.
6ecd619 to
ff1be78
Compare
|
all comments handled |
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.
themselves: a) having a separate Parameters/Returns section for each
of them seems completely overkill; b) most (all?) of them set the
clip_path and the transform on the added artist, so the snippet to
that effect that was present in add_patch should be added to either
all or none of the methods.
PR Summary
PR Checklist