Add caveat around action comments within docstrings (#8432)

Closes https://github.com/astral-sh/ruff/issues/8417.
2023-11-01 20:22:34 -07:00
parent df4dc040de
commit ab6bf50a2d
1 changed files with 2 additions and 0 deletions
--- a/docs/linter.md
+++ b/docs/linter.md
@@ -277,6 +277,8 @@ Ruff will also respect variants of these action comments with a `# ruff:` prefix
 convey that the action comment is intended for Ruff, but are functionally equivalent to the
 isort variants.

+Unlike isort, Ruff does not respect action comments within docstrings.
+
 See the [isort documentation](https://pycqa.github.io/isort/docs/configuration/action_comments.html)
 for more.