Ruff triple-single-quotes (D300)

triple-single-quotes в Ruff проверяет код на предупреждение D300. Правило относится к группе pydocstyle.

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

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

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

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

def kos_root():
    '''Return the pathname of the KOS root directory.'''

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

def kos_root():
    """Return the pathname of the KOS root directory."""

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

Ruff может предложить автоисправление в некоторых случаях.