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
- 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.
PyIncorrectDocstring- 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.
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