Ruff escape-sequence-in-docstring (D301)
escape-sequence-in-docstring в Ruff проверяет код на предупреждение D301. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила escape-sequence-in-docstring и пример ниже.
Пример ошибки
def foobar():
"""Docstring for foo\bar."""
foobar.__doc__ # "Docstring for foar."
Как правильно
def foobar():
r"""Docstring for foo\bar."""
foobar.__doc__ # "Docstring for foo\bar."
Автоисправление
Ruff может предложить автоисправление в некоторых случаях.
