mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-03 07:04:53 +00:00
28c9263722
Previously the rule documentation referenced configuration options
via full https:// URLs, which was bad for several reasons:
* changing the website would mean you'd have to change all URLs
* the links didn't work when building mkdocs locally
* the URLs showed up in the `ruff rule` output
* broken references weren't detected by our CI
This commit solves all of these problems by post-processing the
Markdown, recognizing sections such as:
## Options
* `flake8-tidy-imports.ban-relative-imports`
`cargo dev generate-all` will automatically linkify such references
and panic if the referenced option doesn't exist.
Note that the option can also be linked in the other Markdown sections
via e.g. [`flake8-tidy-imports.ban-relative-imports`] since
the post-processing code generates a CommonMark link definition.
Resolves #2766.
34 lines
No EOL
647 B
Markdown
34 lines
No EOL
647 B
Markdown
# bad-quotes-multiline-string (Q001)
|
|
|
|
Derived from the **flake8-quotes** linter.
|
|
|
|
Autofix is always available.
|
|
|
|
## What it does
|
|
Checks for multiline strings that use single quotes or double quotes,
|
|
depending on the value of the [`flake8-quotes.multiline-quotes`]
|
|
setting.
|
|
|
|
## Why is this bad?
|
|
Consistency is good. Use either single or double quotes for multiline
|
|
strings, but be consistent.
|
|
|
|
## Options
|
|
|
|
* [`flake8-quotes.multiline-quotes`]
|
|
|
|
## Example
|
|
```python
|
|
foo = '''
|
|
bar
|
|
'''
|
|
```
|
|
|
|
Assuming `multiline-quotes` is set to `double`, use instead:
|
|
```python
|
|
foo = """
|
|
bar
|
|
"""
|
|
```
|
|
|
|
[`flake8-quotes.multiline-quotes`]: ../../settings#multiline-quotes |