search

PyCQA / docformatter

Formats docstrings to follow PEP 257
https://pypi.python.org/pypi/docformatter
MIT License
524 stars 61 forks source link

Way to auto fix pydocstyle's D205? #223

Closed manugarri closed 1 year ago

manugarri commented 1 year ago

I am running docformatter on pre-commit. It does save a ton of time for ICs.

Last flag i have been trying to autoformat is pydocstyle D205 (D205: 1 blank line required between summary line and description).

Is there any setting that I can use to ensure there is a new line between summary (a one liner) and description?

Thanks for your help, and thanks for maintaining this awesome project!

weibullguy commented 1 year ago

Can you provide an example (or more) of docstrings where that's not the case?

manugarri commented 1 year ago

actually you are right, i believe the issue was somewhere else on the docstring. Will close this and will reopen if i find a replicable case.