From e58ba7c8400b35c5deff9c3ed0fa8ae92f30d581 Mon Sep 17 00:00:00 2001 From: Victor Wheeler Date: Wed, 11 Sep 2024 07:04:41 -0600 Subject: [PATCH] fix: ``--help`` was being represented incorrectly... (#2213) ...on page `https://www.writethedocs.org/guide/writing/docs-principles/` because the \`\` directive was not being parsed by `spinx` inside an italics paragraph just under the "Principles for publications" heading. This was fixed by terminating the italics block and re-starting it just before and after the ``--help`` respectively. It now appears as originally intended. --- docs/guide/writing/docs-principles.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/writing/docs-principles.rst b/docs/guide/writing/docs-principles.rst index 9a0d6bfa8..85b0d9d23 100644 --- a/docs/guide/writing/docs-principles.rst +++ b/docs/guide/writing/docs-principles.rst @@ -207,8 +207,8 @@ It may be static or interactive — digital or paper. Multiple publications may be created from a single source (such as web and PDF versions of the same manual). Although rarer, multiple sources may be used to create a single publication. More examples of -publications include: API reference, man page, command line -``--help`` output, in-application help tips, online tutorials, +publications include: API reference, man page, command line* +``--help`` *output, in-application help tips, online tutorials, internal engineering manuals, and others too.* Each **publication** should be...