Multiple sentences in multi-line docstring summary #283
Labels
C: convention
Relates to docstring format convention
P: bug
PEP 257 violation or existing functionality that doesn't work as documented
U: high
When reading PEP 257, I am under the impression that the one line summary at the beginning of the docstring should only be composed of a single sentence, from
One-line Docstrings
:From what I have tested, this seems correctly enforced in
docformatter
with single line docstrings. But shouldn't it also be enforce with multi-line docstrings? FromMulti-line Docstrings
:From what I have tested:
Is not reformatted by
docformatter
(1.75
).But:
gets (correctly) reformatted into:
Is this an inconsistency or am I wrong in my interpretation? Thanks!
The text was updated successfully, but these errors were encountered: