Summary line on second line should be allowed

[pycqa]

Summary line on second line should be allowed

[keleshev]

the summary line may be on the same line as the opening quotes or on the next line

I can see that right now pep257 fails to follow this. However I don't agree with your implementation. The quote above sais summary line, which is applicable only to multi-line docstrings that are described as:

Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description.

At the same time one-line docstrings:

They should really fit on one line.
def kos_root():
"""Return the pathname of the KOS root directory."""
global _kos_root
if _kos_root: return _kos_root
...

That means that the following docstrings are incorrect:

"""
Should end with a period.
"""

"""
Blank line missing after one-line summary.

"""

Since they "should really fit on one line".

But the following multi-line string is correct:

"""
Blank line missing after one-line summary.

More elaborate description...

"""

[artloder]

I think the two expected-to-fail cases you provided are already covered by the check_one_liners check. When I run a pep257 against a file using either of those as method docstrings, I receive a One-liner docstrings should fit on one line with quotes message. Given that, any additional checks added would result in duplicate failures, so I think the current implementation is sufficient. Thoughts?

[keleshev]

Actually, yes, those checks take care of it.

[keleshev]

It seems weird though that PEP 257 actually allows this:

"""
Blank line missing after one-line summary.

More elaborate description...

"""