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.
PySingleQuotedDocstringInspection- 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.
Availability
- 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