Skip to content

Commit

Permalink
docs: Explicitly specify language even when it's plain text
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
andrewimeson authored and adrienverge committed Mar 2, 2023
1 parent 06db2af commit 4046563
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/disable_with_comments.rst
Expand Up @@ -117,7 +117,7 @@ post-template processing).
Example of a Jinja2 code that cannot be parsed as YAML because it contains
invalid tokens ``{%`` and ``%}``:

.. code-block::
.. code-block:: text
# This file IS NOT valid YAML and will produce syntax errors
{% if extra_info %}
Expand Down

0 comments on commit 4046563

Please sign in to comment.