docformatter icon indicating copy to clipboard operation
docformatter copied to clipboard

Start sentence with capital letter

Open Borda opened this issue 4 years ago • 1 comments

Hi, I have noticed that the docstring puts "." at the summary end but does not make the first letter capital... I think that it could be quite simple to edit this, what do you think? For example this original:

"""set minimal torch version"""

is converted to:

"""set minimal torch version."""

Borda avatar Aug 02 '21 16:08 Borda

PEP-257 isn't explicit regarding capitalizing the first word in the summary, but it implies such behavior in it's examples. Additionally, pydocstyle will raise a warning (D403) if the first word isn't capitalized.

weibullguy avatar Jul 24 '22 16:07 weibullguy