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 = balanceWhen the quick-fix is applied, the code changes to:
def calc(self, balance=0):
"""param: balance"""
self.balance = balance- 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
Inspection ID: PySingleQuotedDocstringInspection
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 PySingleQuotedDocstringnote
Actual comment syntax will depend on the code language you are working with
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, |