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

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

PyIncorrectDocstring

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Python

Inspection ID: PyIncorrectDocstringInspection

Suppressing Inspection

You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:

//noinspection PyIncorrectDocstring

More detailed instructions as well as other ways and options that you have can be found in the product documentation:

Inspection Details
By default bundled with:	CLion 2025.2, DataSpell 2025.2, IntelliJ IDEA 2025.2, PyCharm 2025.2, Qodana for JVM 2025.2,

Last modified: 18 September 2025