Question

Pylint报告了没有文档字符串的每个函数和方法（__init__除外）的错误。

这通常是可取的，因此我不想全局禁用它（在pylintrc或文件级别）。

但是，在我看来，有些情况下文档字符串不是必需的，甚至是有害的。例如：

def get_foo(self, foo_id):
  """Gets foo by its id."""" 
  return foos[foo_id]

此方法是一个简单的getter，完全由其签名描述。必须编写文档字符串是有害的，因为如果方法被更改，它会创建重复的维护。

我希望能够设置（例如在pylintrc中）docstring_threshold=3之类的内容，以便在函数或方法短于3行代码时禁止丢失文档字符串错误。有没有办法做到这一点？

Answer 1

使用pylint 1.3.1为你添加一行pylintrc docstring-min-length=10。

在生成的pylintrc pylint --generate-rcfile文件中将其描述为

需要文档字符串的函数/类的最小行长度，较短的行可以免除。