language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-17 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Use double quotes for all docstrings, including single-quoted docstrings (#9020)

Browse source
This commit is contained in:
Micha Reiser 2023-12-07 13:41:00 +09:00 • committed by GitHub
parent 946b308197
commit 981a0703ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 209 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
crates/ruff_python_formatter/src/expression/string/mod.rs
View file

@ -213,7 +213,8 @@ impl<'a> Format<PyFormatContext<'_>> for FormatString<'a> {
let normalized = string_part.normalize(
Quoting::CanChange,
&locator,
f.options().quote_style(),
// Per PEP 8 and PEP 257, always prefer double quotes for docstrings
QuoteStyle::Double,
parent_docstring_quote_style,
);
docstring::format(&normalized, f)
@ -323,9 +324,7 @@ impl StringPart {
configured_style: QuoteStyle,
parent_docstring_quote_style: Option<QuoteStyle>,
) -> NormalizedString<'a> {
// Per PEP 8 and PEP 257, always prefer double quotes for docstrings
// and triple-quoted strings. (We assume docstrings are always
// triple-quoted.)
// Per PEP 8, always prefer double quotes for triple-quoted strings.
let preferred_style = if self.quotes.triple {
// ... unless we're formatting a code snippet inside a docstring,
// then we specifically want to invert our quote style to avoid