Применять только строки документации модуля? - PullRequest
0 голосов
/ 27 июня 2019

Я бы хотел постепенно добавлять документацию в мой проект. Моей первой идеей было запустить pylint projectname --disable=all --enable=missing-docstring, но оказалось, что он поддерживает все виды строк документации, а не только строки документов модуля. Есть ли способ отрегулировать это?

1 Ответ

0 голосов
/ 27 июня 2019

pip install flake8_docstrings

На момент написания этого вопроса выяснилось, что у пилинта еще нет этого .Можно добавить этот тип принудительного применения, установив модуль flake8_docstrings flake8, который вводит множество мелких предупреждений, например:

D100 Missing docstring in public module
D101 Missing docstring in public class
D102 Missing docstring in public method
D103 Missing docstring in public function
D104 Missing docstring in public package
D105 Missing docstring in magic method
D107 Missing docstring in __init__
D205 1 blank line required between summary line and description
D209 Multi-line docstring closing quotes should be on a separate line
D400 First line should end with a period
D401 First line should be in imperative mood
...