Ruff non-imperative-mood (D401)

non-imperative-mood в Ruff проверяет код на предупреждение D401. Правило относится к группе pydocstyle.

Почему это неправильно

Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.

Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила non-imperative-mood и пример ниже.

Пример ошибки

def average(values: list[float]) -> float:
    """Returns the mean of the given values."""

Как правильно

def average(values: list[float]) -> float:
    """Return the mean of the given values."""

Автоисправление

Ruff не предлагает автоисправление для этого правила.