Skip to content

Commit 101e80e

Browse files
committed
Tweaked docs
1 parent c2bb934 commit 101e80e

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

Documentation/Configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ top-level keys and values:
1212
should always be `1`.
1313

1414
* `skipAll` _(boolean)_: If this is true, all other configuration
15-
options are ignored, and formatting is disabled.
15+
options are ignored, and formatting/linting is disabled.
1616

1717
* `lineLength` _(number)_: The maximum allowed length of a line, in
1818
characters.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -205,16 +205,17 @@ JSON-formatted file named `.swift-format` in the same directory. If one is
205205
found, then that file is loaded to determine the tool's configuration.
206206

207207
If the file is not found, then it looks in the same directory for a file
208-
called `.no-swift-format`. The presence of this file, if found, will
209-
disable all formatting (the contents of the file are ignored).
208+
called `.no-swift-format`. The presence of this file will
209+
disable all formatting and linting. The contents of `.no-swift-format`
210+
are ignored - it can be an empty file.
210211

211-
If neither file is found, the search for files continues in the parent
212-
directory, and so on.
212+
If neither configuration file is found, the search for files continues
213+
in the parent directory, and so on.
213214

214-
If no configuration file is found, a default configuration is used. The
215-
settings in the default configuration can be viewed by running
216-
`swift-format dump-configuration`, which will dump it to standard
217-
output.
215+
If no configuration file is found at any level, a default configuration
216+
is used. The settings in the default configuration can be viewed by
217+
running `swift-format dump-configuration`, which will dump it to
218+
standard output.
218219

219220
If the `--configuration <file>` option is passed to `swift-format`, then that
220221
configuration will be used unconditionally and the file system will not be

0 commit comments

Comments
 (0)