incorrect-blank-line-before-class (D203)

源自 pydocstyle 代码检查器。

修复总是可用的。

作用

检查类定义上的文档字符串前面是否没有空行。

为什么这不好？

使用空行将文档字符串与类定义分隔开，以保持一致性。

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

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

示例

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

建议改为

class PhotoMetadata:

    """Metadata about a photo."""

Options (选项)

• lint.pydocstyle.convention