Inspectopedia Help

Incorrect docstring

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

Inspection Details

Available in:

DataSpell 2023.3, PyCharm 2023.3


Python Community Edition, 233.SNAPSHOT

Last modified: 13 July 2023