This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Spurious D401 when docstring only contains a Returns section #463
Labels
Waiting for Assignee
This issue has been triaged as a good idea, waiting for a volunteer to implement
Milestone
With
pydocstyle currently warns (in particular)
The first two warnings are reasonable (they are effectively saying "you are missing a summary line" -- a single warning for that would be nicer but things are fine as is), but the last one is spurious: one should be able to disable D205/D400 to allow docstrings without a single summary line while keeping the check for imperative mood when a summary line is present. (pydocstyle already checks for sections in the docstring, so I guess it could just disable D401 when it detects that the first line is indeed a section title?)
The text was updated successfully, but these errors were encountered: