Skip to content

[pyflakes] Add fix safety section to docs (F601, F602) #17440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ntBre merged 2 commits into from
Apr 18, 2025
Merged

[pyflakes] Add fix safety section to docs (F601, F602) #17440

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ff01e3
add fix safety section to docs
Kalmaegi Apr 17, 2025
1108f66
add mention of side effects
ntBre Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions crates/ruff_linter/src/rules/pyflakes/rules/repeated_keys.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ use crate::registry::Rule;
/// foo["baz"] # 2
/// ```
///
/// ## Fix safety
///
/// This rule's fix is marked as unsafe because removing a repeated dictionary key
/// may delete comments that are attached to the removed key-value pair. This can also change
/// the program's behavior if the value expressions have side effects.
///
/// ## References
/// - [Python documentation: Dictionaries](https://docs.python.org/3/tutorial/datastructures.html#dictionaries)
#[derive(ViolationMetadata)]
Expand Down Expand Up @@ -106,6 +112,12 @@ impl Violation for MultiValueRepeatedKeyLiteral {
/// foo[baz] # 2
/// ```
///
/// ## Fix safety
///
/// This rule's fix is marked as unsafe because removing a repeated dictionary key
/// may delete comments that are attached to the removed key-value pair. This can also change
/// the program's behavior if the value expressions have side effects.
///
/// ## References
/// - [Python documentation: Dictionaries](https://docs.python.org/3/tutorial/datastructures.html#dictionaries)
#[derive(ViolationMetadata)]
Expand Down
Loading