PY3.C0116

Missing function docstring

Missing function or method docstring used when a function or method has no docstring. Some special methods like init, protected, private functions, setters and deleters do not require a docstring (learn more from testscases). It's a good practice to describe what a function does for other programmers.

Noncompliant Code:

Copy
def foo():
    pass

Compliant Code:

Copy
def foo():
    """A dummy docstring."""

The content on this page is adapted from the Pylint User Guide, Copyright ©2003-2022, Logilab, PyCQA and contributors. All rights reserved. https://pylint.pycqa.org/en/latest/index.html#, and is used under the Python Software Foundation License Version 2. Examples, recipes, and other code in the Pylint documentation are additionally licensed under the Zero Clause BSD License.