docs: fix warning about matrix.json not valid for code highlighting #793
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixing the following warning: ```sh Warning, treated as error: hunter/docs/creating-new/test/ci.rst:84:Could not lex literal_block as "JSON". Highlighting skipped. ``` The referenced codeblock is the following: ```rst .. literalinclude:: ../../../.github/workflows/ci/matrix.json :language: JSON ``` The `matrix.json` file contains `//` comments, which are not valid json tripping the highlighting. Removing the `:language: JSON` part fixes this warning Fixes: cpp-pm#790
|
misspelled error moved to new issue: #794 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixing the following warning:
Warning, treated as error: hunter/docs/creating-new/test/ci.rst:84:Could not lex literal_block as "JSON". Highlighting skipped.The referenced codeblock is the following:
The
matrix.jsonfile contains//comments, which are not valid json tripping the highlighting.Removing the
:language: JSONpart fixes this warningFixes: #790