跳到内容

incorrect-blank-line-after-class (D204)

源自 pydocstyle 代码检查器。

修复总是可用的。

作用

检查类的文档字符串和类方法之间是否缺少空行。

为什么这不好？

PEP 257 建议使用空行将类的文档字符串与其方法分隔开。

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

示例

class PhotoMetadata:
    """Metadata about a photo."""
    def __init__(self, file: Path):
        ...

建议改为

class PhotoMetadata:
    """Metadata about a photo."""

    def __init__(self, file: Path):
        ...

Options (选项)

参考