From 30e238d5f1826b2cf92832d1ea17b5a1d3e54cd0 Mon Sep 17 00:00:00 2001 From: Tom Mrazauskas Date: Sat, 14 Sep 2024 16:24:07 +0300 Subject: [PATCH] chore: tweak `useConsistentArrayType` rule documentation (#3891) --- .../src/lint/style/use_consistent_array_type.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/crates/biome_js_analyze/src/lint/style/use_consistent_array_type.rs b/crates/biome_js_analyze/src/lint/style/use_consistent_array_type.rs index e6ddc7f2d282..0d5addcf20eb 100644 --- a/crates/biome_js_analyze/src/lint/style/use_consistent_array_type.rs +++ b/crates/biome_js_analyze/src/lint/style/use_consistent_array_type.rs @@ -49,9 +49,8 @@ declare_lint_rule! { /// ``` /// /// ## Options - /// The rule provides two options that help to specify what type of array declarations to use. /// - /// Default: "shorthand" + /// Use the options to specify the syntax of array declarations to use. /// /// ```json /// { @@ -61,10 +60,14 @@ declare_lint_rule! { /// } /// } /// ``` - /// ### Syntax /// - /// By default, all array declarations will be converted to `T[]` or `readonly T[]`, which it means `shorthand`, - /// or if the options is set to the "generic", that all will converted to `Array` or `ReadonlyArray`. + /// ### syntax + /// + /// The syntax to use: + /// - `generic`: array declarations will be converted to `Array` or `ReadonlyArray` + /// - `shorthand`: array declarations will be converted to `T[]` or `readonly T[]` + /// + /// Default: `shorthand` /// pub UseConsistentArrayType { version: "1.5.0",