Skip to content

Commit 62eb754

Browse files
Improve wording on configuration and dependencies pages (#3012)
1 parent 6513e7f commit 62eb754

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documentation/snapshot/docs/rules/configuration-ktlint.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Ktlint uses a limited set of `.editorconfig` properties for additional configura
22

33
!!! danger
44

5-
Unfortunately [IntelliJ IDEA](https://www.jetbrains.com/idea/) has an [autoformat issue regarding `.editorconfig`](https://youtrack.jetbrains.com/issue/IDEA-242506). Due to this error an additional space is added between glob statements, resulting in `[*{kt, kts}]` instead of `[*{kt,kts}]`. The `.editorconfig` library used by `ktlint` [ignores sections after encountering a space in the list](https://github.com/editorconfig/editorconfig/issues/148). As a result, the rule is not applied on all files as documented in the [original ktlint issue](https://github.com/pinterest/ktlint/issues/762).
5+
Unfortunately, [IntelliJ IDEA](https://www.jetbrains.com/idea/) has an [autoformat issue regarding `.editorconfig`](https://youtrack.jetbrains.com/issue/IDEA-242506). Due to this error, an additional space is added between glob statements, resulting in `[*{kt, kts}]` instead of `[*{kt,kts}]`. The `.editorconfig` library used by `ktlint` [ignores sections after encountering a space in the list](https://github.com/editorconfig/editorconfig/issues/148). As a result, the rule is not applied on all files as documented in the [original ktlint issue](https://github.com/pinterest/ktlint/issues/762).
66

77
## Code style
88

@@ -24,7 +24,7 @@ ktlint_experimental = enabled # Enable all `experimental` rules from all rule se
2424
ktlint_custom-rule-set = enabled # Enable all rules in the `custom-rule-set` rule set (not provided by KtLint)
2525
```
2626

27-
Rules that are marked as experimental will not be run, unless explicitly enabled:
27+
Rules that are marked as experimental will not run unless explicitly enabled:
2828
```editorconfig
2929
ktlint_experimental = enabled # Enable rules marked as experimental for all rule sets that are enabled
3030
```
@@ -41,7 +41,7 @@ ktlint_custom-rule-set_custom-rule = disabled # Disables the `custom-rule` rule
4141

4242
## Rule specific configuration settings
4343

44-
The configuration settings below are used to configure the behavior of a specific rule. As of that, those settings only take effect when the corresponding rule is enabled. See description of rule for more information about the setting.
44+
The configuration settings below are used to configure the behavior of a specific rule. As of that, those settings only take effect when the corresponding rule is enabled. See the description of the specific rule for more information about the setting.
4545

4646
| Configuration setting | Rule |
4747
|:------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|
@@ -72,4 +72,4 @@ ktlint_standard_import-ordering = disabled
7272
ktlint_standard_indent = disabled
7373
```
7474

75-
Note that in example above the `import-ordering` rule is disabled for *all* packages including the `api` sub package. Next to this the `indent` rule is disabled for the `api` package and its sub packages.
75+
Note: In the example above the `import-ordering` rule is disabled for *all* packages, including the `api` sub package. Next to this, the `indent` rule is disabled for the `api` package and its sub packages.

0 commit comments

Comments
 (0)