Skip to content

Commit b2975de

Browse files
committed
Documentation tweaks.
1 parent 7b35513 commit b2975de

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,9 @@ configuration, by redirecting it to a file and editing it.
203203
For any source file being checked or formatted, `swift-format` looks for
204204
configuration files in the same directory, and parent directories.
205205

206-
If it finds a file named `.swift-format-ignore`, it will disable all
207-
formatting and linting.
206+
If it finds a file named `.swift-format-ignore`, its contents will determine
207+
which files in that directory will be ignored by `swift-format`. Currently
208+
the only supported option is `*`, which ignores all files.
208209

209210
If it finds a JSON-formatted file called `.swift-format`, then that
210211
file is loaded to determine the tool's configuration.
@@ -216,15 +217,12 @@ standard output.
216217

217218
If the `--configuration <file>` option is passed to `swift-format`, then that
218219
configuration will be used unconditionally and the file system will not be
219-
searched.
220+
searched for `.swift-format` files.
220221

221222
See [Documentation/Configuration.md](Documentation/Configuration.md) for a
222223
description of the configuration file format and the settings that are
223224
available.
224225

225-
Note that the contents of any `.swift-format-ignore` are ignored; the
226-
file can be empty.
227-
228226
### Miscellaneous
229227

230228
Running `swift-format -v` or `swift-format --version` will print version

0 commit comments

Comments
 (0)