doc: avoid two warnings#781
Merged
Merged
Conversation
Two shell code blocks are not marked as such, confusing rst to consider them as yaml. Be explicit about their syntax, and use $ prompt to match elsewhere in the docs. /home/travis/build/canonical/cloud-init/doc/rtd/topics/format.rst:28: WARNING: Could not lex literal_block as "yaml". Highlighting skipped. /home/travis/build/canonical/cloud-init/doc/rtd/topics/format.rst:52: WARNING: Could not lex literal_block as "yaml". Highlighting skipped. Signed-off-by: Dan Kenigsberg <danken@redhat.com>
dankenigsberg
force-pushed
the
doc-avoid-morning
branch
from
383d42d to
4b85b0b
Compare
Contributor
|
Hi @dankenigsberg , thanks for the contribution. Your change looks good. I noticed you signed our CLA, but after signing the CLA, you also need to add your Github username to |
Copying into git data that is maintained somewhere else sounds like an inconsistency waiting to happen. Oh well. Signed-off-by: Dan Kenigsberg <danken@redhat.com>
dankenigsberg
force-pushed
the
doc-avoid-morning
branch
from
c7578a2 to
82bc2eb
Compare
TheRealFalcon
approved these changes
Jan 21, 2021
Contributor
|
Thanks! We'll get this merged once CI passes. |
andrewbogott
pushed a commit
to andrewbogott/cloud-init
that referenced
this pull request
Jan 21, 2021
Two shell code blocks are not marked as such, confusing rst to consider them as yaml. Be explicit about their syntax, and use $ prompt to match elsewhere in the docs. /home/travis/build/canonical/cloud-init/doc/rtd/topics/format.rst:28: WARNING: Could not lex literal_block as "yaml". Highlighting skipped. /home/travis/build/canonical/cloud-init/doc/rtd/topics/format.rst:52: WARNING: Could not lex literal_block as "yaml". Highlighting skipped. Signed-off-by: Dan Kenigsberg <danken@redhat.com>
This was referenced May 12, 2023
Closed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Two shell code blocks are not marked as such, confusing rst to consider
them as yaml. Be explicit about their syntax, and use $ prompt to match
elsewhere in the docs.
Signed-off-by: Dan Kenigsberg danken@redhat.com
Checklist: