mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-02 18:02:23 +00:00
Add documentation for flake8-quotes rules (#2650)
This commit is contained in:
parent
367f115d83
commit
a9aa96b24f
10 changed files with 192 additions and 8 deletions
|
@ -1,5 +1,7 @@
|
|||
# assert-raises-exception (B017)
|
||||
|
||||
Derived from the **flake8-bugbear** linter.
|
||||
|
||||
### What it does
|
||||
Checks for `self.assertRaises(Exception)`.
|
||||
|
||||
|
|
23
docs/rules/avoid-quote-escape.md
Normal file
23
docs/rules/avoid-quote-escape.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# avoid-quote-escape (Q003)
|
||||
|
||||
Derived from the **flake8-quotes** linter.
|
||||
|
||||
Autofix is always available.
|
||||
|
||||
### What it does
|
||||
Checks for strings that include escaped quotes, and suggests changing
|
||||
the quote style to avoid the need to escape them.
|
||||
|
||||
### Why is this bad?
|
||||
It's preferable to avoid escaped quotes in strings. By changing the
|
||||
outer quote style, you can avoid escaping inner quotes.
|
||||
|
||||
### Example
|
||||
```python
|
||||
foo = 'bar\'s'
|
||||
```
|
||||
|
||||
Use instead:
|
||||
```python
|
||||
foo = "bar's"
|
||||
```
|
27
docs/rules/bad-quotes-docstring.md
Normal file
27
docs/rules/bad-quotes-docstring.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# bad-quotes-docstring (Q002)
|
||||
|
||||
Derived from the **flake8-quotes** linter.
|
||||
|
||||
Autofix is always available.
|
||||
|
||||
### What it does
|
||||
Checks for docstrings that use single quotes or double quotes, depending on the value of the [`docstring-quotes`](https://github.com/charliermarsh/ruff#docstring-quotes)
|
||||
setting.
|
||||
|
||||
### Why is this bad?
|
||||
Consistency is good. Use either single or double quotes for docstring
|
||||
strings, but be consistent.
|
||||
|
||||
### Example
|
||||
```python
|
||||
'''
|
||||
bar
|
||||
'''
|
||||
```
|
||||
|
||||
Assuming `docstring-quotes` is set to `double`, use instead:
|
||||
```python
|
||||
"""
|
||||
bar
|
||||
"""
|
||||
```
|
24
docs/rules/bad-quotes-inline-string.md
Normal file
24
docs/rules/bad-quotes-inline-string.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# bad-quotes-inline-string (Q000)
|
||||
|
||||
Derived from the **flake8-quotes** linter.
|
||||
|
||||
Autofix is always available.
|
||||
|
||||
### What it does
|
||||
Checks for inline strings that use single quotes or double quotes,
|
||||
depending on the value of the [`inline-quotes`](https://github.com/charliermarsh/ruff#inline-quotes)
|
||||
setting.
|
||||
|
||||
### Why is this bad?
|
||||
Consistency is good. Use either single or double quotes for inline
|
||||
strings, but be consistent.
|
||||
|
||||
### Example
|
||||
```python
|
||||
foo = 'bar'
|
||||
```
|
||||
|
||||
Assuming `inline-quotes` is set to `double`, use instead:
|
||||
```python
|
||||
foo = "bar"
|
||||
```
|
28
docs/rules/bad-quotes-multiline-string.md
Normal file
28
docs/rules/bad-quotes-multiline-string.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
# 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 [`multiline-quotes`](https://github.com/charliermarsh/ruff#multiline-quotes)
|
||||
setting.
|
||||
|
||||
### Why is this bad?
|
||||
Consistency is good. Use either single or double quotes for multiline
|
||||
strings, but be consistent.
|
||||
|
||||
### Example
|
||||
```python
|
||||
foo = '''
|
||||
bar
|
||||
'''
|
||||
```
|
||||
|
||||
Assuming `multiline-quotes` is set to `double`, use instead:
|
||||
```python
|
||||
foo = """
|
||||
bar
|
||||
"""
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue