From ab6bf50a2dc26ad3b8d07186d796ea3d28084070 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Wed, 1 Nov 2023 20:22:34 -0700 Subject: [PATCH] Add caveat around action comments within docstrings (#8432) Closes https://github.com/astral-sh/ruff/issues/8417. --- docs/linter.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/linter.md b/docs/linter.md index 6c94ac3e57..85d6a8775c 100644 --- 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.