Fix incorrect formatting in docs #930
Merged
Conversation
This file contains 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
samdoran
added
docs
webknjaz
reviewed
Nov 30, 2021
samdoran
force-pushed
the
docs/fix-formatting
branch
from
6f68800
to
ee68b4f
Compare
RST uses double backticks to indicate verbati formatting but there were many places that used only a single backtick, which is correct for Markdown.
Setting the default_role to 'any' is a bit indirect, but it has the effect of catching words surround only by single backticks. Also enable nitpicky mode which will catch bad references.
samdoran
force-pushed
the
docs/fix-formatting
branch
from
e782c84
to
6c7783c
Compare
Shrews
approved these changes
Dec 6, 2021
![ansible-zuul[bot]](https://avatars.githubusercontent.com/in/27800?s=60&v=4){kind=small}
samdoran
added a commit
to samdoran/ansible-runner
that referenced
this pull request
Dec 6, 2021
Fix incorrect formatting in docs RST uses double backticks to indicate verbatim formatting but there were many places that used only a single backtick, which is correct for Markdown. Also change the documentation config to catch these errors in CI. Reviewed-by: Sviatoslav Sydorenko <webknjaz+github/profile@redhat.com> Reviewed-by: Sam Doran <sdoran@redhat.com> Reviewed-by: David Shrewsbury <None> Reviewed-by: None <None>. (cherry picked from commit 6d99dae) Co-authored-by: Sam Doran <sdoran@redhat.com>
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.
RST uses double backticks to indicate verbatim formatting but there were many places that used only a single backtick, which is correct for Markdown.
Also change the documentation config to catch these errors in CI.