style(docs): Fix RST lint errors reported by doc8

pull/144/head
Adrien Vergé 6 years ago
parent 6cf5eecdac
commit a56a1015f0

@ -45,9 +45,9 @@ It can be chosen using:
Extending the default configuration Extending the default configuration
----------------------------------- -----------------------------------
When writing a custom configuration file, you don't need to redefine every rule. When writing a custom configuration file, you don't need to redefine every
Just extend the ``default`` configuration (or any already-existing configuration rule. Just extend the ``default`` configuration (or any already-existing
file). configuration file).
For instance, if you just want to disable the ``comments-indentation`` rule, For instance, if you just want to disable the ``comments-indentation`` rule,
your file could look like this: your file could look like this:
@ -105,8 +105,8 @@ Problems detected by yamllint can be raised either as errors or as warnings.
The CLI will output them (with different colors when using the ``colored`` The CLI will output them (with different colors when using the ``colored``
output format, or ``auto`` when run from a terminal). output format, or ``auto`` when run from a terminal).
By default the script will exit with a return code ``1`` *only when* there is one or By default the script will exit with a return code ``1`` *only when* there is
more error(s). one or more error(s).
However if strict mode is enabled with the ``-s`` (or ``--strict``) option, the However if strict mode is enabled with the ``-s`` (or ``--strict``) option, the
return code will be: return code will be:

@ -4,9 +4,9 @@ Disable with comments
Disabling checks for a specific line Disabling checks for a specific line
------------------------------------ ------------------------------------
To prevent yamllint from reporting problems for a specific line, add a directive To prevent yamllint from reporting problems for a specific line, add a
comment (``# yamllint disable-line ...``) on that line, or on the line above. directive comment (``# yamllint disable-line ...``) on that line, or on the
For instance: line above. For instance:
.. code-block:: yaml .. code-block:: yaml
@ -46,9 +46,9 @@ If you need to disable multiple rules, it is allowed to chain rules like this:
Disabling checks for all (or part of) the file Disabling checks for all (or part of) the file
---------------------------------------------- ----------------------------------------------
To prevent yamllint from reporting problems for the whole file, or for a block of To prevent yamllint from reporting problems for the whole file, or for a block
lines within the file, use ``# yamllint disable ...`` and ``# yamllint enable of lines within the file, use ``# yamllint disable ...`` and ``# yamllint
...`` directive comments. For instance: enable ...`` directive comments. For instance:
.. code-block:: yaml .. code-block:: yaml

@ -68,9 +68,9 @@ The output will look like (colors are not displayed here):
10:1 error too many blank lines (4 > 2) (empty-lines) 10:1 error too many blank lines (4 > 2) (empty-lines)
11:4 error too many spaces inside braces (braces) 11:4 error too many spaces inside braces (braces)
By default, the output of yamllint is colored when run from a terminal, and pure By default, the output of yamllint is colored when run from a terminal, and
text in other cases. Add the ``-f standard`` arguments to force non-colored output. pure text in other cases. Add the ``-f standard`` arguments to force
Use the ``-f colored`` arguments to force colored output. non-colored output. Use the ``-f colored`` arguments to force colored output.
Add the ``-f parsable`` arguments if you need an output format parsable by a Add the ``-f parsable`` arguments if you need an output format parsable by a
machine (for instance for :doc:`syntax highlighting in text editors machine (for instance for :doc:`syntax highlighting in text editors

Loading…
Cancel
Save