NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2025-02-25 18:55:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix new rstcheck errors

Browse Source 
Some YAML snippets from the examples were actually invalid.
This commit is contained in:
Adrien Vergé 2023-11-21 22:19:43 +01:00
parent 8713140e99
commit 1f79e62a98
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/disable_with_comments.rst
View File

@ -12,11 +12,11 @@ line above. For instance:
# The following mapping contains the same key twice,
# but I know what I'm doing:
key: value 1
key: value 2 # yamllint disable-line rule:key-duplicates
- key: value 1
key: value 2 # yamllint disable-line rule:key-duplicates
- This line is waaaaaaaaaay too long but yamllint will not report anything about it. # yamllint disable-line rule:line-length
This line will be checked by yamllint.
- This line will be checked by yamllint.
or:
@ -24,13 +24,13 @@ or:
# The following mapping contains the same key twice,
# but I know what I'm doing:
key: value 1
# yamllint disable-line rule:key-duplicates
key: value 2
- key: value 1
# yamllint disable-line rule:key-duplicates
key: value 2
# yamllint disable-line rule:line-length
- This line is waaaaaaaaaay too long but yamllint will not report anything about it.
This line will be checked by yamllint.
- This line will be checked by yamllint.
It is possible, although not recommend, to disabled **all** rules for a
specific line:
@ -90,8 +90,8 @@ For instance:
# yamllint disable-file
# The following mapping contains the same key twice, but I know what I'm doing:
key: value 1
key: value 2
- key: value 1
key: value 2
- This line is waaaaaaaaaay too long but yamllint will not report anything about it.