Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add caveat around action comments within docstrings (#8432) 

Closes https://github.com/astral-sh/ruff/issues/8417.
This commit is contained in:
Charlie Marsh 2023-11-01 20:22:34 -07:00 committed by GitHub
parent df4dc040de
commit ab6bf50a2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/linter.md
View File

@ -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 convey that the action comment is intended for Ruff, but are functionally equivalent to the
isort variants. 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) See the [isort documentation](https://pycqa.github.io/isort/docs/configuration/action_comments.html)
for more. for more.