Skip to content

Commit

Permalink
doc. Improved documentation. Closes #74.
Browse files Browse the repository at this point in the history
  • Loading branch information
tamere-allo-peter committed Apr 6, 2022
1 parent 47bcd55 commit d749235
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,18 @@ strict mode before, else `-1`.
For convenience, all or parts of the command line arguments can be
read from a file, one per line, by using the well known `@argsfile`
syntax.
syntax. For example you could do something like this :
```shell
$ find . -type f -name "*.yml" >list-of-yaml-files
$ yamlfixer --nochange --summary @list-of-yaml-files
```
Although this could probably be shortened to :
```shell
$ yamlfixer --nochange --summary --recurse -1 .
```
**IMPORTANT:** Not all problems are fixable by `yamlfixer`. Due to the
fact that `yamllint` doesn't currently report all faulty lines,
Expand Down

0 comments on commit d749235

Please sign in to comment.