Skip to content
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.

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

chore: tweak useConsistentArrayType rule documentation #3891

Merged
Merged
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -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
/// {
Expand All @@ -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<T>` or `ReadonlyArray<T>`.
/// ### syntax
dyc3 marked this conversation as resolved.
Show resolved Hide resolved
///
/// The syntax to use:
/// - `generic`, array declarations will be converted to `Array<T>` or `ReadonlyArray<T>`
/// - `shorthand`, array declarations will be converted to `T[]` or `readonly T[]`
///
/// Default: `shorthand`
///
pub UseConsistentArrayType {
version: "1.5.0",
Expand Down
Loading