Ruff undocumented-public-package (D104)
undocumented-public-package в Ruff проверяет код на предупреждение D104. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-package и пример ниже.
Пример ошибки
__all__ = ["Player", "Game"]
Как правильно
"""Game and player management package.
This package provides classes for managing players and games.
"""
__all__ = ["player", "game"]
Автоисправление
Ruff не предлагает автоисправление для этого правила.
