From df25e329376e9e4843a5f448cd875787a732e11b Mon Sep 17 00:00:00 2001 From: Jacqui Shadforth Date: Sat, 4 Jan 2025 18:07:20 +0000 Subject: [PATCH] Add missing argument in CLI docs (#2921) --- documentation/release-latest/docs/install/cli.md | 6 +++--- documentation/snapshot/docs/install/cli.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/release-latest/docs/install/cli.md b/documentation/release-latest/docs/install/cli.md index 9d2f73a4ea..157d785806 100644 --- a/documentation/release-latest/docs/install/cli.md +++ b/documentation/release-latest/docs/install/cli.md @@ -134,10 +134,10 @@ Some rules can be tweaked via the [`editorconfig file`](../../rules/configuratio A scaffold of the `.editorconfig` file can be generated with command below. Note: that the generated file only contains configuration settings which are actively used by the [rules which are loaded](#rule-sets): ```shell title="Generate .editorconfig" -# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig -ktlint generateEditorConfig ktlint_official +# Specify the code style (ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig +ktlint generateEditorConfig --code-style ktlint_official # or -ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio +ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig --code-style android_studio ``` Normally the `.editorconfig` file is located in the root of your project directory. In case the file is located in a sub folder of the project, the settings of that file only applies to that subdirectory and its folders (recursively). Ktlint automatically detects and reads all `.editorconfig` files in your project. diff --git a/documentation/snapshot/docs/install/cli.md b/documentation/snapshot/docs/install/cli.md index 9d2f73a4ea..157d785806 100644 --- a/documentation/snapshot/docs/install/cli.md +++ b/documentation/snapshot/docs/install/cli.md @@ -134,10 +134,10 @@ Some rules can be tweaked via the [`editorconfig file`](../../rules/configuratio A scaffold of the `.editorconfig` file can be generated with command below. Note: that the generated file only contains configuration settings which are actively used by the [rules which are loaded](#rule-sets): ```shell title="Generate .editorconfig" -# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig -ktlint generateEditorConfig ktlint_official +# Specify the code style (ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig +ktlint generateEditorConfig --code-style ktlint_official # or -ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio +ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig --code-style android_studio ``` Normally the `.editorconfig` file is located in the root of your project directory. In case the file is located in a sub folder of the project, the settings of that file only applies to that subdirectory and its folders (recursively). Ktlint automatically detects and reads all `.editorconfig` files in your project.