Pylintは、docstringを持たないすべての関数とメソッド(__init__
を除く)のエラーを報告します。
これは一般的に望ましいので、グローバルに(pylintrc
で、またはファイルレベルで)無効にしたくありません。
しかし、私の意見では、docstringが不要で、有害でさえある場合があります。例えば:
def get_foo(self, foo_id):
"""Gets foo by its id.""""
return foos[foo_id]
このメソッドは、その署名によって完全に記述される単純なゲッターです。 docstringを書かなければならないことは、メソッドが変更された場合に重複したメンテナンスを作成するという点で有害です。
関数またはメソッドが3行のコードより短い場合に欠落しているdocstringエラーを抑制するために、docstring_threshold=3
のようなものを(たとえばpylintrc
に)設定できるようにしたいと思います。それを行う方法はありますか?
Pylint 1.3.1を使用して、たとえばpylintrc docstring-min-length=10
に行を追加します。
生成されたpylintrcpylint --generate-rcfile
ファイルに次のように記述されています。
Docstringを必要とする関数/クラスの最小行長。短いものは免除されます。