CLN: D213: Multi-line docstring summary should start at the second line #31893
Conversation
simonjayhawkins
changed the title
| @@ -86,7 +86,8 @@ class IndexingError(Exception): | |||
|
|
|||
|
|
|||
| class IndexingMixin: | |||
| """Mixin for adding .loc/.iloc/.at/.iat to Datafames and Series. | |||
| """ | |||
| Mixin for adding .loc/.iloc/.at/.iat to Datafames and Series. | |||
| """ | |||
There was a problem hiding this comment.
do we have a policy on whether this should be one line or not?
There was a problem hiding this comment.
there is D200 One-line docstring should fit on one line with quotes, see http://www.pydocstyle.org/en/5.0.2/error_codes.html, but I think that would go against the code cleanups in #31162, #31462 and others.
we want consistency. so we need a policy.
There was a problem hiding this comment.
there are ~550 one-line docstrings split over 3 lines.
pandas/io/common.py
Outdated
| @@ -74,7 +74,8 @@ def is_url(url) -> bool: | |||
| def _expand_user( | |||
| filepath_or_buffer: FilePathOrBuffer[AnyStr], | |||
| ) -> FilePathOrBuffer[AnyStr]: | |||
| """Return the argument with an initial component of ~ or ~user | |||
| """ | |||
| Return the argument with an initial component of ~ or ~user | |||
| replaced by that user's home directory. | |||
There was a problem hiding this comment.
this introduces a weird alignment here
There was a problem hiding this comment.
this PR is just D213, the alignment will be fixed with D207/D208
There was a problem hiding this comment.
so some overlap here with #31890, and D207/D208 will need to be rerun after D209/D213 merged
There was a problem hiding this comment.
i'll push the fix in this PR. (prob thur)
|
Mostly looks fine, only question is if we want to avoid introducing alignment mismatches |
|
Can you merge master? |
…docstring-summary-should-start-at-the-second-line
pandas/io/excel/_base.py
Outdated
| @@ -755,7 +756,8 @@ def _value_with_fmt(self, val): | |||
|
|
|||
| @classmethod | |||
| def check_extension(cls, ext): | |||
| """checks that path's extension against the Writer's supported | |||
| """ | |||
| checks that path's extension against the Writer's supported | |||
| extensions. If it isn't supported, raises UnsupportedFiletypeError.""" | |||
There was a problem hiding this comment.
Since you are changing things here, can you put the ending triple quotes on their own line as well? (other cases below as well)
There was a problem hiding this comment.
probably best to merge #31891 first, since less violations there and once merged this diff should look good and any leftover misalignment can be pushed here.
…docstring-summary-should-start-at-the-second-line
pandas/io/common.py
Outdated
| @@ -74,7 +74,8 @@ def is_url(url) -> bool: | |||
| def _expand_user( | |||
| filepath_or_buffer: FilePathOrBuffer[AnyStr], | |||
| ) -> FilePathOrBuffer[AnyStr]: | |||
| """Return the argument with an initial component of ~ or ~user | |||
| """ | |||
| Return the argument with an initial component of ~ or ~user | |||
| replaced by that user's home directory. | |||
There was a problem hiding this comment.
i'll push the fix in this PR. (prob thur)
pandas/core/generic.py
Outdated
| cacher. | ||
| """ | ||
| self._cacher = (item, weakref.ref(cacher)) | ||
|
|
||
| def _reset_cacher(self) -> None: | ||
| """Reset the cacher.""" | ||
| """ | ||
| Reset the cacher.""" |
There was a problem hiding this comment.
i'll fix in this PR
…docstring-summary-should-start-at-the-second-line
…docstring-summary-should-start-at-the-second-line
…docstring-summary-should-start-at-the-second-line
simonjayhawkins
deleted the
D213--Multi-line-docstring-summary-should-start-at-the-second-line
branch
No description provided.