Skip to content

docs(linter): Fix docs for the curly rule. #18374

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
graphite-app merged 1 commit into from
Jan 22, 2026
Merged

docs(linter): Fix docs for the curly rule. #18374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions crates/oxc_linter/src/rules/eslint/curly.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,12 @@ declare_oxc_lint!(
/// }
/// ```
///
/// #### `{ "consistent": true }`
/// #### `"consistent"`
///
/// When enabled, `consistent: true` enforces consistent use of braces within an `if-else` chain.
/// When enabled, `"consistent"` enforces consistent use of braces within an `if-else` chain.
/// If one branch of the chain uses braces, then all branches must use braces, even if not strictly required by the first option.
///
/// Examples of **incorrect** code with `"multi"` and `consistent: true`:
/// Examples of **incorrect** code with `"multi"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi", "consistent"] */
///
Expand All @@ -199,7 +199,7 @@ declare_oxc_lint!(
/// }
/// ```
///
/// Examples of **correct** code with `"multi"` and `consistent: true`:
/// Examples of **correct** code with `"multi"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi", "consistent"] */
///
Expand All @@ -218,7 +218,7 @@ declare_oxc_lint!(
/// }
/// ```
///
/// Examples of **incorrect** code with `"multi-line"` and `consistent: true`:
/// Examples of **incorrect** code with `"multi-line"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi-line", "consistent"] */
///
Expand All @@ -228,7 +228,7 @@ declare_oxc_lint!(
/// baz();
/// ```
///
/// Examples of **correct** code with `"multi-line"` and `consistent: true`:
/// Examples of **correct** code with `"multi-line"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi-line", "consistent"] */
///
Expand All @@ -239,7 +239,7 @@ declare_oxc_lint!(
/// }
/// ```
///
/// Examples of **incorrect** code with `"multi-or-nest"` and `consistent: true`:
/// Examples of **incorrect** code with `"multi-or-nest"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi-or-nest", "consistent"] */
///
Expand All @@ -248,7 +248,7 @@ declare_oxc_lint!(
/// } else qux();
/// ```
///
/// Examples of **correct** code with `"multi-or-nest"` and `consistent: true`:
/// Examples of **correct** code with `"multi-or-nest"` and `"consistent"`:
/// ```js
/// /* curly: ["error", "multi-or-nest", "consistent"] */
///
Expand Down
Loading