mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-01 05:18:06 +07:00
Louis Vignierandintellij-monorepo-bot
1869ec9da6
GitOrigin-RevId: 56876a5dd073a06c3fcc92f63ed1f5674830bc25
27 lines
527 B
HTML
27 lines
527 B
HTML
<html>
|
|
<body>
|
|
<p>Reports missing and empty docstrings.</p>
|
|
<p><b>Example of a missing docstring</b></p>
|
|
<pre><code>
|
|
def demo(a):
|
|
c = a ** 2
|
|
</code></pre>
|
|
<p><b>Example of an empty docstring</b></p>
|
|
<pre><code>
|
|
def demo(a):
|
|
"""
|
|
"""
|
|
c = a ** 2
|
|
</code></pre>
|
|
<p>When the quick-fix is applied, the code fragments change to:</p>
|
|
<pre><code>
|
|
def demo(a):
|
|
"""
|
|
|
|
:param a:
|
|
"""
|
|
c = a ** 2
|
|
</code></pre>
|
|
<p>You need to provide some details about the parameter in the generated template.</p>
|
|
</body>
|
|
</html> |