Inspectopedia Help

Missing or empty docstring

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.

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