Fix incorrect generateEditorConfig example in documentation (#2444)

pinterest · Dec 19, 2023 · 19a547d · 19a547d
1 parent ebfe2d0
commit 19a547d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 8 deletions.
diff --git a/documentation/release-latest/docs/install/cli.md b/documentation/release-latest/docs/install/cli.md
@@ -141,10 +141,8 @@ 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"
-# By default use ktlint_official
-ktlint generateEditorConfig
-# or
-ktlint generateEditorConfig intellij_idea
+# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
+ktlint generateEditorConfig ktlint_official
 # or
 ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio
 ```

diff --git a/documentation/snapshot/docs/install/cli.md b/documentation/snapshot/docs/install/cli.md
@@ -141,10 +141,8 @@ 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"
-# By default use ktlint_official
-ktlint generateEditorConfig
-# or
-ktlint generateEditorConfig intellij_idea
+# Specify the code style(ktlint_official, intellij_idea or android_studio) to be used when generating the .editorconfig
+ktlint generateEditorConfig ktlint_official
 # or
 ktlint --ruleset=/path/to/custom-ruleset.jar generateEditorConfig android_studio
 ```