Fix usages of single backticks to double backticks #591
Conversation
In RST, text wrapped in a `single backtick` is meant for "interpreted text", and is rendered using <cite> tags. Verbatim/literal text should instead be wrapped in ``double backticks``, which is rendered using <code> tags. See https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup
|
Note: I only checked the |
|
Based on the output of this issue is also present in testing.rst, translators.rst, the manpage, and the README. |
|
@cebtenzzre thanks for looking that up! Would you like write access to my fork so you could make the changes to the other files? |
|
Looks like I already had access. I pushed fixes for those files, and I also corrected a few references in the manpage (e.g. |
Oh, right, it didn't occur to me to check that you had collaborator status in this repo. In that case, yeah, it's expected that you would have write access to the PR branch.
Looks great! I confess I'm not 100% sure about when the interpreted text markup is supposed to be used, but those command references definitely don't look like things that should be marked up as code/verbatim. Thanks for taking this on! |
vassilit
dismissed
their stale review
Upon consideration, there are places where the single backticks would be more appropriate.
3 participants
In RST, text wrapped in a `single backtick` is meant for "interpreted text", and is rendered using
<cite>tags. Verbatim/literal text should instead be wrapped in ``double backticks``, which is rendered using<code>tags.See https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup