Ruff unnecessary-multiline-docstring (D200)
unnecessary-multiline-docstring в Ruff проверяет код на предупреждение D200. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила unnecessary-multiline-docstring и пример ниже.
Пример ошибки
def average(values: list[float]) -> float:
"""
Return the mean of the given values.
"""
Как правильно
def average(values: list[float]) -> float:
"""Return the mean of the given values."""
Автоисправление
Ruff может предложить автоисправление в некоторых случаях.
