如何在不触发 D205 和 D400 的情况下在多行上编写文档字符串摘要？

Question

说我有

def foo()
    """This is the first part of the summary, 
    and this is the second part of the summary.

    This is the description.
    """

我触发了D205和D400 docstring样式警告。 我希望能够打破界限，因为我正在处理 80 列的限制并且我想保留它。

我应该忽略这些警告吗？

Answer 1

来自pycodestyle文档：

D205 ：摘要行和描述之间需要1个空白行

D400 : 第一行应该以句点结尾

所以这应该没问题：

def foo():
    """This is the first line of the summary.

    and this is the second.
    This is the description.
    """

回答你的评论：

Pep-0257说：

多行文档字符串由一个摘要行组成，就像单行文档字符串一样，然后是一个空行，然后是更详细的描述。 自动索引工具可以使用摘要行； 重要的是它适合一行，并通过空行与文档字符串的 rest 分开。

所以你应该把它缩小，使它适合一行。 第一行被一些库使用，比如click 。 因此，多行摘要一开始就不正确。