Inspectopedia 2024.3 Help

Single quoted docstring

Reports docstrings that do not adhere to the triple double-quoted string format.

Example:

def calc(self, balance=0): 'param: balance' self.balance = balance

When the quick-fix is applied, the code changes to:

def calc(self, balance=0): """param: balance""" self.balance = balance

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.

PySingleQuotedDocstring
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 Details

By default bundled with:

CLion 2024.3, IntelliJ IDEA 2024.3, PyCharm 2024.3, Qodana for JVM 2024.3,

Can be installed with plugin:

Python Community Edition, 243.23126

Last modified: 03 December 2024