PYTHON.CONVENTION.MFD : Missing Function Docstring (Pylint)

This warning class corresponds to a Pylint rule. The CodeSonar analysis results may include warnings of this class if your CodeSonar project includes Python components.

要旨

This warning class corresponds to the Pylint missing-function-docstring rule. For full rule details, see the Pylint website: missing-function-docstring / C0116.

プロパティ

クラス名 Missing Function Docstring (Pylint)
日本語クラス名 Missing Function Docstring (Pylint)
クラス分類 スタイル (style)
ニーモニック PYTHON.CONVENTION.MFD
カテゴリー
CWE CWE:1059 Insufficient Technical Documentation
Pylint Pylint:C0116 missing-function-docstring
対応言語 Python で利用可能です。
有効/無効設定 Checking for this warning class is performed by the third party Pylint analyzer, with the results imported into the CodeSonar project.

To enable or disable checking, you will need to adjust your adjust your Pylint configuration.

If the checker produces one or more results corresponding to this warning class, they will be submitted to the hub by default. To disable submission, add the following WARNING_FILTER rule to the project configuration file.

WARNING_FILTER += discard class="Missing Function Docstring (Pylint)"

関連のある設定ファイルパラメータ

設定ファイルの以下のパラメータがこのワーニングクラスのチェックに影響します。