Ruff undocumented-public-nested-class (D106)
undocumented-public-nested-class в Ruff проверяет код на предупреждение D106. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-nested-class и пример ниже.
Пример ошибки
class Foo:
"""Class Foo."""
class Bar: ...
bar = Foo.Bar()
bar.__doc__ # None
Как правильно
class Foo:
"""Class Foo."""
class Bar:
"""Class Bar."""
bar = Foo.Bar()
bar.__doc__ # "Class Bar."
Автоисправление
Ruff не предлагает автоисправление для этого правила.
