unnecessary-multiline-docstring (D200)

源自 pydocstyle 代码检查器。

有时提供修复。

作用

检查跨越多行的单行文档字符串。

为什么这不好？

PEP 257 建议，可以放在一行的文档字符串应格式化为单行，以保持一致性和可读性。

示例

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."""

修复安全性

此修复程序被标记为不安全，因为它可能会影响解析文档字符串的工具、文档生成器或依赖于特定文档字符串格式的自定义内省实用程序。

参考

• PEP 257 – 文档字符串约定