pylint-errors
C0116 (missing-function-docstring)
Problematic code:
def foo():
pass
Correct code:
def foo():
"""A dummy docstring."""
Rationale:
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.