blank-line-before-class (D211)

源自 pydocstyle 代码检查器。

修复总是可用的。

作用

检查类定义之前的文档字符串是否以空行开头。

为什么这不好？

为了保持一致性，避免在类定义和其文档字符串之间引入任何空行。

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

有关替代方案，请参阅 D203。

示例

class PhotoMetadata:

    """Metadata about a photo."""

建议改为

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

Options (选项)

• lint.pydocstyle.convention