非祈使语气 (D401)

源自 pydocstyle 代码检查器。

作用

检查文档字符串的第一行是否未使用祈使语气。

PEP 257 建议为保持一致性，文档字符串的第一行应使用祈使语气书写。

提示：若要将文档字符串改写为祈使语气，请将第一行表述为祈使句（即命令句）。

此规则可能并不适用于所有项目；其适用性取决于具体约定。默认情况下，该规则在使用 numpy 和 pep257 约定时处于启用状态，而在使用 google 约定时处于禁用状态。

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

建议改为

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