跳到内容

missing-trailing-period (D400)

源自 pydocstyle 代码检查器。

有时提供修复。

作用

检查文档字符串中第一行是否未以句点结尾。

为什么这不好？

PEP 257 建议文档字符串的第一行应以命令形式书写，并以句点结尾。

此规则可能不适用于所有项目；其适用性是一个约定问题。默认情况下，使用 numpy 和 pep257 约定启用此规则，而使用 google 约定禁用此规则。

示例

def average(values: list[float]) -> float:
    """Return the mean of the given values"""

建议改为

def average(values: list[float]) -> float:
    """Return the mean of the given values."""

Options (选项)

参考