Update YAMLSyntax.rst with yamllint (#66622)

* Update YAMLSyntax.rst with yamllint

Co-authored-by: Sandra McCann <samccann@redhat.com>
pull/67434/head
Bas 6 years ago committed by GitHub
parent 68620ced7f
commit f35293c052
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -40,21 +40,21 @@ A dictionary is represented in a simple ``key: value`` form (the colon must be f
# An employee record # An employee record
martin: martin:
name: Martin D'vloper name: Martin D'vloper
job: Developer job: Developer
skill: Elite skill: Elite
More complicated data structures are possible, such as lists of dictionaries, dictionaries whose values are lists or a mix of both:: More complicated data structures are possible, such as lists of dictionaries, dictionaries whose values are lists or a mix of both::
# Employee records # Employee records
- martin: - martin:
name: Martin D'vloper name: Martin D'vloper
job: Developer job: Developer
skills: skills:
- python - python
- perl - perl
- pascal - pascal
- tabitha: - tabitha:
name: Tabitha Bitumen name: Tabitha Bitumen
job: Developer job: Developer
skills: skills:
@ -80,6 +80,8 @@ Ansible doesn't really use these too much, but you can also specify a boolean va
likes_emacs: TRUE likes_emacs: TRUE
uses_cvs: false uses_cvs: false
Use lowercase 'true' or 'false' for boolean values in dictionaries if you want to be compatible with default yamllint options.
Values can span multiple lines using ``|`` or ``>``. Spanning multiple lines using a "Literal Block Scalar" ``|`` will include the newlines and any trailing spaces. Values can span multiple lines using ``|`` or ``>``. Spanning multiple lines using a "Literal Block Scalar" ``|`` will include the newlines and any trailing spaces.
Using a "Folded Block Scalar" ``>`` will fold newlines to spaces; it's used to make what would otherwise be a very long line easier to read and edit. Using a "Folded Block Scalar" ``>`` will fold newlines to spaces; it's used to make what would otherwise be a very long line easier to read and edit.
In either case the indentation will be ignored. In either case the indentation will be ignored.
@ -117,18 +119,18 @@ This really has nothing to do with Ansible, but will give you a feel for the for
skill: Elite skill: Elite
employed: True employed: True
foods: foods:
- Apple - Apple
- Orange - Orange
- Strawberry - Strawberry
- Mango - Mango
languages: languages:
perl: Elite perl: Elite
python: Elite python: Elite
pascal: Lame pascal: Lame
education: | education: |
4 GCSEs 4 GCSEs
3 A-Levels 3 A-Levels
BSc in the Internet of Things BSc in the Internet of Things
That's all you really need to know about YAML to start writing `Ansible` playbooks. That's all you really need to know about YAML to start writing `Ansible` playbooks.
@ -238,4 +240,3 @@ value::
implementing implementing
`YAML 1.2 Specification <https://yaml.org/spec/1.2/spec.html>`_ `YAML 1.2 Specification <https://yaml.org/spec/1.2/spec.html>`_
For completeness, YAML 1.2 is the successor of 1.1 For completeness, YAML 1.2 is the successor of 1.1

Loading…
Cancel
Save