Skip to content

Commit a90c7e8

Browse files
committed
Update README with new --help output, prepare for 6.0.0 release
1 parent 29d7dda commit a90c7e8

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,25 +54,26 @@ looking up the directory tree until it finds one. If Yamale can not find a schem
5454

5555
Usage:
5656

57-
```bash
57+
```
5858
usage: yamale [-h] [-s SCHEMA] [-e PATTERN] [-p PARSER] [-n CPU_NUM] [-x] [-v] [-V] [PATH ...]
5959
6060
Validate yaml files.
6161
6262
positional arguments:
63-
PATH paths to validate, either directories or files. Default is the current directory.
63+
PATH Paths to validate, either directories or files. Default is the current directory.
6464
6565
options:
6666
-h, --help show this help message and exit
6767
-s SCHEMA, --schema SCHEMA
6868
filename of schema. Default is schema.yaml.
6969
-e PATTERN, --exclude PATTERN
70-
Python regex used to exclude files from validation. Any substring match of a files absolute path will be excluded. Uses deafult Python3 regex. Option can be supplied multiple times.
70+
Python regex used to exclude files from validation. Any substring match of a file's absolute path will be excluded. Uses
71+
default Python3 regex. Option can be supplied multiple times.
7172
-p PARSER, --parser PARSER
7273
YAML library to load files. Choices are "ruamel" or "pyyaml" (default).
7374
-n CPU_NUM, --cpu-num CPU_NUM
74-
number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count.
75-
-x, --no-strict disable strict mode, unexpected elements in the data will be accepted.
75+
Number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count.
76+
-x, --no-strict Disable strict mode, unexpected elements in the data will be accepted.
7677
-v, --verbose show verbose information
7778
-V, --version show program's version number and exit
7879
```

yamale/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.3.0
1+
6.0.0

0 commit comments

Comments
 (0)