python-3.x PyLint/PyLint 3无法识别文档字符串

2g32fytz 于 2023-02-06 发布在 Python

关注(0)|答案(1)|浏览(131)

我编写了几个Python 3模块，格式如下：

def some_module():
'''Do something.

Parameters
----------
Returns
-------
'''
# Some code

当我在文件上运行PyLint或PyLint 3时，我得到以下错误：

*************模块某个模块。某个模块

C：1，0：缺少模块文档字符串（missing-docstring）
我做错了什么？PyLint需要特定的文档字符串样式吗？

1条答案

您是否尝试过缩进文档字符串，以便将其标识为模块的一部分？

def some_module():
    '''Do something.

    Parameters
    ----------
    Returns
    -------
    '''
    # Some code
    ...