编号 | C0116 |
标题 | 缺少函数或方法的文档字符串 |
语言 | Python |
级别 | 3 |
类别 | 常规 |
规范说明
当一个函数或方法没有文档字符串时使用。一些特殊的方法如init不需要文档字符串。
- 问题代码
import sys
def print_python_version(): # [missing-function-docstring]
print(sys.version)
- 正确代码
import sys
def print_python_version():
"""Function printing python version."""
print(sys.version)
来源:https://pylint.readthedocs.io