fix: --help was being represented incorrectly...
#2213
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
...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.
My pleasure! I hadn't realized up until a few days ago that there was even a technical-writers community -- on GitHub no less! And the write-the-docs website is rich with ideas and tech-writing (especially code documentation) principles. My tail is wagging, to be sure! |
|
@plaindocs Wow! I love the fast turn-around! It's already reflected in the on-line website. Bravo!! 🥇 👍 |
|
Yep, it's one of the truely awesome things about docs as code! |
True that! |
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.
...on page
https://www.writethedocs.org/guide/writing/docs-principles/because the `` directive was not being parsed bysphinxinside 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
--helprespectively. It now appears as originally intended.No issue was created about this.
📚 Documentation preview 📚: https://writethedocs-www--2213.org.readthedocs.build/