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: Explicitly specify language even when it's plain text

Browse Source 
rstcheck succeeds with a failure (heh) when there's a code block without
a language specified. This can lead to false negatives as the file is no
longer being checked by rstcheck.

Error:

    An `AttributeError` error occured. This is most propably due to a
    code block directive (code/code-block/sourcecode) without a
    specified language. This may result in a false negative for source:
    'docs/disable_with_comments.rst'. See
    https://rstcheck-core.readthedocs.io/en/latest/faq/#code-blocks-without-language-sphinx
    for more information.  Success! No issues detected.
This commit is contained in:
Andrew Imeson 2023-03-01 14:45:26 -05:00 committed by Adrien Vergé
parent 06db2af9b0
commit 404656394c
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/disable_with_comments.rst
View File

@ -117,7 +117,7 @@ post-template processing).
Example of a Jinja2 code that cannot be parsed as YAML because it contains Example of a Jinja2 code that cannot be parsed as YAML because it contains
invalid tokens ``{%`` and ``%}``: invalid tokens ``{%`` and ``%}``:
.. code-block:: .. code-block:: text
# This file IS NOT valid YAML and will produce syntax errors # This file IS NOT valid YAML and will produce syntax errors
{% if extra_info %} {% if extra_info %}