跳到内容

存根中的文档字符串 (PYI021)

源自 flake8-pyi 代码检查器。

修复总是可用的。

作用

检查存根文件中是否存在文档字符串。

为什么这不好?

存根文件应该省略文档字符串,因为它们的目的是提供类型提示,而不是文档。

示例

def func(param: int) -> str:
    """This is a docstring."""
    ...

建议改为

def func(param: int) -> str: ...