Add "(when enabled)" to default values
Also, unquote strings.
This commit is contained in:
@@ -28,7 +28,7 @@ Use this rule to control the number of spaces inside braces (``{`` and ``}``).
|
||||
* ``max-spaces-inside-empty`` defines the maximal number of spaces allowed
|
||||
inside empty braces.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ Use this rule to control the number of spaces inside brackets (``[`` and
|
||||
* ``max-spaces-inside-empty`` defines the maximal number of spaces allowed
|
||||
inside empty brackets.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ Use this rule to control the number of spaces before and after colons (``:``).
|
||||
* ``max-spaces-after`` defines the maximal number of spaces allowed after
|
||||
colons (use ``-1`` to disable).
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ Use this rule to control the number of spaces before and after commas (``,``).
|
||||
* ``max-spaces-after`` defines the maximal number of spaces allowed after
|
||||
commas (use ``-1`` to disable).
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ Use this rule to control the position and formatting of comments.
|
||||
content. It defines the minimal required number of spaces between a comment
|
||||
and its preceding content.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Use this rule to require or forbid the use of document end marker (``...``).
|
||||
* Set ``present`` to ``true`` when the document end marker is required, or to
|
||||
``false`` when it is forbidden.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Use this rule to require or forbid the use of document start marker (``---``).
|
||||
* Set ``present`` to ``true`` when the document start marker is required, or to
|
||||
``false`` when it is forbidden.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ Use this rule to set a maximal number of allowed consecutive blank lines.
|
||||
* ``max-end`` defines the maximal number of empty lines allowed at the end of
|
||||
the file. This option takes precedence over ``max``.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ Use this rule to prevent nodes with empty content, that implicitly result in
|
||||
* Use ``forbid-in-block-mappings`` to prevent empty values in block mappings.
|
||||
* Use ``forbid-in-flow-mappings`` to prevent empty values in flow mappings.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Use this rule to control the number of spaces after hyphens (``-``).
|
||||
* ``max-spaces-after`` defines the maximal number of spaces allowed after
|
||||
hyphens.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -32,13 +32,13 @@ Use this rule to control the indentation.
|
||||
* ``check-multi-line-strings`` defines whether to lint indentation in
|
||||
multi-line strings. Set to ``true`` to enable, ``false`` to disable.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rules:
|
||||
indentation:
|
||||
spaces: 'consistent'
|
||||
spaces: consistent
|
||||
indent-sequences: true
|
||||
check-multi-line-strings: false
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ recommend running yamllint with Python 3.
|
||||
* ``allow-non-breakable-inline-mappings`` implies ``allow-non-breakable-words``
|
||||
and extends it to also allow non-breakable words in inline mappings.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -22,13 +22,13 @@ Use this rule to force the type of new line characters.
|
||||
* Set ``type`` to ``unix`` to use UNIX-typed new line characters (``\\n``), or
|
||||
``dos`` to use DOS-typed new line characters (``\\r\\n``).
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rules:
|
||||
new-lines:
|
||||
type: 'unix'
|
||||
type: unix
|
||||
"""
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ converted to ``8``.
|
||||
* Use ``forbid-implicit-octal`` to prevent numbers starting with ``0``.
|
||||
* Use ``forbid-explicit-octal`` to prevent numbers starting with ``0o``.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
@@ -34,13 +34,13 @@ used.
|
||||
|
||||
**Note**: Multi-line strings (with ``|`` or ``>``) will not be checked.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rules:
|
||||
quoted-strings:
|
||||
quote-type: 'any'
|
||||
quote-type: any
|
||||
required: true
|
||||
extra-required: []
|
||||
extra-allowed: []
|
||||
|
||||
@@ -34,7 +34,7 @@ This can be useful to prevent surprises from YAML parsers transforming
|
||||
``truthy`` rule applies to both keys and values. Set this option to ``false``
|
||||
to prevent this.
|
||||
|
||||
.. rubric:: Default values
|
||||
.. rubric:: Default values (when enabled)
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
||||
Reference in New Issue
Block a user