CLN: D208 Docstring is over-indented #31890
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
| @@ -601,8 +601,7 @@ def __init__(self, value, converted, kind: str): | |||
| self.kind = kind | |||
|
|
|||
| def tostring(self, encoding) -> str: | |||
| """ quote the string if not encoded | |||
| else encode and return """ | |||
| """ quote the string if not encoded else encode and return """ | |||
There was a problem hiding this comment.
are the leading/trailing spaces policy?
There was a problem hiding this comment.
not according to PEP257, but that seems to popular in our codebase. There is a codecheck in pydocstyle for this, D210. This is for one-line docstrings and we seem to moving away from those, see #31162, #31462 and others.
I was wandering whether to enforce D210 yet. May be able to find a checker to find one-liners.
There was a problem hiding this comment.
I think this would fail the numpy docstring check as well were this exposed as part of the API
|
LGTM |
WillAyd
approved these changes
Feb 11, 2020
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.
No description provided.