Back to Intellij Community

PyMissingOrEmptyDocstringInspection

python/python-psi-impl/resources/inspectionDescriptions/PyMissingOrEmptyDocstringInspection.html

2025.3-rc-2409 B
Original Source

Reports missing and empty docstrings.

Example of a missing docstring

def demo(a):
    c = a ** 2

Example of an empty docstring

def demo(a):
    """
    """
    c = a ** 2

When the quick-fix is applied, the code fragments change to:

def demo(a):
    """

    :param a:
    """
    c = a ** 2

You need to provide some details about the parameter in the generated template.