From bbb9fe169207091e899dda15383f0ef16beb00b7 Mon Sep 17 00:00:00 2001 From: Jack Desert Date: Wed, 10 Jul 2024 12:29:29 -0400 Subject: [PATCH] [Docs] Clear instruction for single quotes (linter and formatter) (#12015) ## Summary In order to use single quotes with both the ruff linter and the ruff formatter, two different rules must be applied. This was not clear to me when internet searching "configure ruff single quotes" and it eventually I filed this issue: https://github.com/astral-sh/ruff/issues/12003 --- docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index c69a92b69c..23acfdede9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -195,7 +195,7 @@ As an example, the following would configure Ruff to: "**/{tests,docs,tools}/*" = ["E402"] [tool.ruff.format] - # 5. Use single quotes for non-triple-quoted strings. + # 5. Use single quotes in `ruff format`. quote-style = "single" ``` @@ -218,7 +218,7 @@ As an example, the following would configure Ruff to: "**/{tests,docs,tools}/*" = ["E402"] [format] - # 5. Use single quotes for non-triple-quoted strings. + # 5. Use single quotes in `ruff format`. quote-style = "single" ```