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

Locating this inspection


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

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


By default bundled with

DataSpell 2024.1, IntelliJ IDEA 2024.1, PyCharm 2024.1, Qodana for JVM 2024.1,

Can be installed with plugin

Python Community Edition, 241.SNAPSHOT

Last modified: 18 June 2024