未记录公共包 (D104)
源自 pydocstyle 代码检查器。
作用
检查未记录的公共包定义。
为什么这不好?
公共包应该通过文档字符串来记录,以概述其目的和内容。
通常,包的文档字符串应该列出包导出的模块和子包。
如果代码库遵循包文档字符串的标准格式,为了保持一致性,请遵循该格式。
示例
建议改为
"""Game and player management package.
This package provides classes for managing players and games.
"""
__all__ = ["player", "game"]