跳到内容

undocumented-public-package (D104)

添加于 v0.0.70 · 相关议题 · 查看源码

源自 pydocstyle 代码检查器。

作用

检查未包含文档说明的公共包定义。

为什么这不好?

公共包应通过文档字符串(docstrings)进行说明,以概述其用途和内容。

通常,包的文档字符串应列出该包导出的模块和子包。

如果代码库对包的文档字符串有统一的标准格式,请遵循该格式以保持一致性。

示例

__all__ = ["Player", "Game"]

建议改为

"""Game and player management package.

This package provides classes for managing players and games.
"""

__all__ = ["player", "game"]

Options (选项)

参考