Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/285.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python 仅强制模块docstring?_Python_Pylint - Fatal编程技术网

Python 仅强制模块docstring?

Python 仅强制模块docstring?,python,pylint,Python,Pylint,我想逐渐地将文档添加到我的项目中。我的第一个想法是运行pylint projectname--disable=all--enable=missing docstring,但事实证明它强制执行所有类型的docstring,而不仅仅是模块docstring。有办法调整吗?pip安装flake 8\u docstrings 在写这个问题的时候,似乎。可以通过安装flake8\u docstringsflake8模块来添加这种强制,该模块引入了许多细粒度警告,例如: D100 Missing docst

我想逐渐地将文档添加到我的项目中。我的第一个想法是运行
pylint projectname--disable=all--enable=missing docstring
,但事实证明它强制执行所有类型的docstring,而不仅仅是模块docstring。有办法调整吗?

pip安装flake 8\u docstrings

在写这个问题的时候,似乎。可以通过安装
flake8\u 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

是什么阻止了您逐渐添加文档并将pylint警告用作指导方针,而不是错误?@mistermiagi让CI自动执行此命令,让您可以测量进度,并以一种干净的方式判断Git分支是否符合指导方针。它在我的组织中起作用(在一定程度上)。