Docstring cleanup #14337
Merged
Docstring cleanup #14337
Conversation
This file contains 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
reviewed
May 26, 2019
lib/matplotlib/rcsetup.py
Outdated
| @@ -237,8 +237,8 @@ def validate_int_or_None(s): | |||
|
|
|||
| def validate_fonttype(s): | |||
| """ | |||
| confirm that this is a Postscript of PDF font type that we know how to | |||
| convert to | |||
| Confirm that this is a Postscript of PDF font type that we know how to | |||
anntzer
reviewed
May 26, 2019
lib/matplotlib/rcsetup.py
Outdated
| @@ -305,7 +305,7 @@ def __init__(self, n=None, allow_none=False): | |||
| self.allow_none = allow_none | |||
|
|
|||
| def __call__(self, s): | |||
| """return a seq of n floats or raise""" | |||
| """Return a seq of n floats or raise.""" | |||
anntzer
reviewed
May 26, 2019
lib/matplotlib/rcsetup.py
Outdated
| @@ -329,7 +329,7 @@ def __init__(self, n=None): | |||
| self.n = n | |||
|
|
|||
| def __call__(self, s): | |||
| """return a seq of n ints or raise""" | |||
| """Return a seq of n ints or raise.""" | |||
QuLogic
reviewed
May 26, 2019
lib/matplotlib/rcsetup.py
Outdated
| try: | ||
| return int(s) | ||
| except ValueError: | ||
| raise ValueError('Could not convert "%s" to int' % s) | ||
|
|
||
|
|
||
| def validate_int_or_None(s): | ||
| """if not None, tries to validate as an int""" | ||
| """If not None, tries to validate as an int.""" |
There was a problem hiding this comment.
Should rewrite to "Convert ..." like its non-None version.
| @@ -713,7 +713,7 @@ def _calc_offsets(appended_sizes, karray): | |||
|
|
|||
| def new_locator(self, nx, nx1=None): | |||
| """ | |||
| returns a new locator | |||
| Returns a new locator | |||
| @@ -806,7 +806,7 @@ class VBoxDivider(HBoxDivider): | |||
|
|
|||
| def new_locator(self, ny, ny1=None): | |||
| """ | |||
| returns a new locator | |||
| Returns a new locator | |||
| @@ -251,7 +251,7 @@ def pick(self, mouseevent): | |||
|
|
|||
| def twinx(self, axes_class=None): | |||
| """ | |||
| create a twin of Axes for generating a plot with a sharex | |||
| Create a twin of Axes for generating a plot with a sharex | |||
| @@ -309,7 +309,7 @@ def _remove_twiny(self, ax): | |||
|
|
|||
| def twin(self, aux_trans=None, axes_class=None): | |||
| """ | |||
| create a twin of Axes for generating a plot with a sharex | |||
| Create a twin of Axes for generating a plot with a sharex | |||
There was a problem hiding this comment.
Wait is this even right for twin?
dstansby
approved these changes
May 27, 2019
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
May 27, 2019
dstansby
added a commit
that referenced
this pull request
May 27, 2019
…337-on-v3.1.x Backport PR #14337 on branch v3.1.x (Docstring cleanup)
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
Some docstring cleanup. Mainly capitalization (pydocstyle D403).
There's much more to do, but I don't trust automatic regexp replacements here. Therefore, I'll take it slow and do bits at a time. With that I can do other small doc improvements on the go and the PR does not become too large to review.