Missing or empty docstring
Reports missing and empty docstrings.
Example of a missing docstring
def demo(a):
c = a ** 2
Example of an empty docstring
def demo(a):
"""
"""
c = a ** 2
When the quick-fix is applied, the code fragments change to:
def demo(a):
"""
:param a:
"""
c = a ** 2
You need to provide some details about the parameter in the generated template.
Inspection Details | |
|---|---|
Available in: | DataSpell 2023.3, PyCharm 2023.3 |
Plugin: | Python Community Edition, 233.SNAPSHOT |
Last modified: 13 July 2023