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
Inspection Details | |
---|---|
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: 29 April 2024