Ruff signature-in-docstring (D402)
signature-in-docstring в Ruff проверяет код на предупреждение D402. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила signature-in-docstring и пример ниже.
Пример ошибки
def foo(a, b):
"""foo(a: int, b: int) -> list[int]"""
Как правильно
def foo(a: int, b: int) -> list[int]:
"""Return a list of a and b."""
Автоисправление
Ruff не предлагает автоисправление для этого правила.
