Ruff docstring-in-stub (PYI021)
docstring-in-stub в Ruff проверяет код на предупреждение PYI021. Правило относится к группе flake8-pyi.
Почему это неправильно
Файлы заглушек должны точно и компактно описывать интерфейс, иначе типизаторы будут давать неверные подсказки.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила docstring-in-stub и пример ниже.
Пример ошибки
def func(param: int) -> str:
"""This is a docstring."""
...
Как правильно
def func(param: int) -> str: ...
Автоисправление
Ruff всегда может предложить автоисправление для этого правила.
