update docstrings

astral-sh · Aug 7, 2024 · 858bf05 · 858bf05
1 parent fcc8cf0
commit 858bf05
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_getitem.rs b/crates/ruff_linter/src/rules/ruff/rules/incorrectly_parenthesized_tuple_in_getitem.rs
@@ -12,7 +12,7 @@ use crate::checkers::ast::Checker;
 
 /// ## What it does
 /// Checks for use or omission of parentheses around tuples in subscripts,
-/// depending on the setting [`lint.ruff.parenthesize-tuple-in-getitem`]. By default, the use of parentheses
+/// depending on the setting [`lint.ruff.parenthesize-tuple-in-subscript`]. By default, the use of parentheses
 /// is considered a violation.
 ///
 /// ## Why is this bad?

diff --git a/crates/ruff_workspace/src/options.rs b/crates/ruff_workspace/src/options.rs
@@ -2985,8 +2985,8 @@ pub struct RuffOptions {
         default = r#"false"#,
         value_type = "bool",
         example = r#"
-        # Make it a violation to use `__getitem__` with a tuple argument without parentheses.
-        parenthesize-tuple-in-getitem = true
+        # Make it a violation to use a tuple in a subscript without parentheses.
+        parenthesize-tuple-in-subscript = true
         "#
     )]
     pub parenthesize_tuple_in_subscript: Option<bool>,