Ignore D401 warnings in pydocstyle?

ufal / neuralmonkey

An open-source tool for sequence learning in NLP built on TensorFlow.

BSD 3-Clause "New" or "Revised" License

410 stars 104 forks source link

Ignore D401 warnings in pydocstyle? #780

Open jindrahelcl opened 5 years ago

jindrahelcl commented 5 years ago

D401 warns about the first line of the docstring not being in the imperative mood. This is bad especially for @property methods. Should we turn D401 off? At least until the issue is solved...

https://github.com/PyCQA/pydocstyle/issues/301 https://github.com/flycheck/flycheck/commit/79e5cd45e69cfed89048a47e0a922e0ef781a611

varisd commented 5 years ago

Why don't we just add ignore-decorators=property to .pycodestyle file as suggested in the link above?

jindrahelcl commented 5 years ago

then all docstring warnings will be ignored, not just the imperative mood check.