PyLint / PyLint3无法识别文档字符串

Question

我编写了以下格式的几个Python 3模块：

def some_module():
'''Do something.

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

在文件上运行PyLint或PyLint3时，出现以下错误：

  

*************模块some_module.some_module
  C：1，0：缺少模块文档字符串（missing-docstring）

我在做什么错？ PyLint是否需要特定的文档字符串样式？

Answer 1

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

def some_module():
    '''Do something.

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