PyLint/PyLint 3不识别docstring

Question

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

def some_module():
'''Do something.

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

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

*模块some_module.some_module C: 1，0:缺少模块docstring (缺少-docstring)

我做错了什么？PyLint是否需要特定的docstring样式？

Answer 1

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

def some_module():
    '''Do something.

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