This commit is contained in:
Anthony Sottile 2018-03-19 10:13:18 -07:00 committed by GitHub
parent 7212f9408e
commit 1bdd699a79
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -52,7 +52,7 @@ Add this to your `.pre-commit-config.yaml`
- `check-yaml` - Attempts to load all yaml files to verify syntax. - `check-yaml` - Attempts to load all yaml files to verify syntax.
- `--allow-multiple-documents` - allow yaml files which use the - `--allow-multiple-documents` - allow yaml files which use the
[multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML) [multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML)
- `--unsafe` - Instaed of loading the files, simply parse them for syntax. - `--unsafe` - Instead of loading the files, simply parse them for syntax.
A syntax-only check enables extensions and unsafe constructs which would A syntax-only check enables extensions and unsafe constructs which would
otherwise be forbidden. Using this option removes all guarantees of otherwise be forbidden. Using this option removes all guarantees of
portability to other yaml implementations. portability to other yaml implementations.