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

Improve f-string-missing-placeholders documentation (#2800)

This commit is contained in:
Charlie Marsh 2023-02-11 23:58:24 -05:00 committed by GitHub
parent 0e4d5eeea7
commit 4a12ebb9b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/ruff/src/rules/pyflakes/rules/f_string_missing_placeholders.rs
View File

@ -13,8 +13,13 @@ define_violation!(
///
/// ## Why is this bad?
/// F-strings are a convenient way to format strings, but they are not
/// necessary if there are no placeholder expressions to format. In this case,
/// a regular string should be used instead.
/// necessary if there are no placeholder expressions to format. In this
/// case, a regular string should be used instead, as an f-string without
/// placeholders can be confusing for readers, who may expect such a
/// placeholder to be present.
///
/// An f-string without any placeholders could also indicate that the
/// author forgot to add a placeholder expression.
///
/// ## Example
/// ```python

9
docs/rules/f-string-missing-placeholders.md
View File

@ -9,8 +9,13 @@ Checks for f-strings that do not contain any placeholder expressions.
## Why is this bad?
F-strings are a convenient way to format strings, but they are not
necessary if there are no placeholder expressions to format. In this case,
a regular string should be used instead.
necessary if there are no placeholder expressions to format. In this
case, a regular string should be used instead, as an f-string without
placeholders can be confusing for readers, who may expect such a
placeholder to be present.
An f-string without any placeholders could also indicate that the
author forgot to add a placeholder expression.
## Example
```python