Back to Intellij Community

PyIncorrectDocstringInspection

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

2025.3-rc-2392 B
Original Source

Reports mismatched parameters in a docstring. For example, b is highlighted, because there is no such a parameter in the add function.

def add(a, c):
    """
    @param a:
    @param b:
    @return:
    """
    pass

The inspection does not warn you of missing parameters if none of them is mentioned in a docstring:

def mult(a, c):
    """
    @return:
    """
    pass