Files
openide/python/python-psi-impl/resources/inspectionDescriptions/PyIncorrectDocstringInspection.html
Louis Vignier 1869ec9da6 [codeInspection] Fix python inspection descriptions
GitOrigin-RevId: 56876a5dd073a06c3fcc92f63ed1f5674830bc25
2023-04-28 13:13:25 +00:00

23 lines
497 B
HTML

<html>
<body>
<p>Reports mismatched parameters in a docstring. For example, <code>b</code> is highlighted, because there is no
such a parameter in the <code>add</code> function.</p>
<pre><code>
def add(a, c):
"""
@param a:
@param b:
@return:
"""
pass
</code></pre>
<p>The inspection does not warn you of missing parameters if none of them is mentioned in a docstring:</p>
<pre><code>
def mult(a, c):
"""
@return:
"""
pass
</code></pre>
</body>
</html>