From b6db090cee3b9de4f9dea1fd636a12575ad9ea70 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Mon, 14 Jan 2019 17:25:33 -0500 Subject: [PATCH] Minor text edits for clarity. Signed-off-by: MCamp859 --- .../reference/collaboration/collaboration.rst | 2 +- .../collaboration/structure-formatting.rst | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/clear-linux/reference/collaboration/collaboration.rst b/source/clear-linux/reference/collaboration/collaboration.rst index 4f924050..e4a101c1 100644 --- a/source/clear-linux/reference/collaboration/collaboration.rst +++ b/source/clear-linux/reference/collaboration/collaboration.rst @@ -22,7 +22,7 @@ readable documentation. :maxdepth: 1 Writing guide describes the style we use to keep our documents clear and concise. - Structure and formatting guide details how we structure and format our documents using reStructuredText and Sphinx. + Structure and formatting guide explains how we use reStructuredText and Sphinx. GitHub documentation repository shows our document organization. How to contribute diff --git a/source/clear-linux/reference/collaboration/structure-formatting.rst b/source/clear-linux/reference/collaboration/structure-formatting.rst index ab521891..d97e2937 100644 --- a/source/clear-linux/reference/collaboration/structure-formatting.rst +++ b/source/clear-linux/reference/collaboration/structure-formatting.rst @@ -158,10 +158,10 @@ Use our quick reference for the most commonly used inline text elements: +--------------------------------+---------------------------------------+-----------------------------+ | **Element** | **Convention** | **reST/Sphinx** | +--------------------------------+---------------------------------------+-----------------------------+ -| Acronyms | Spell out first use, with | Use ``:abbr:`` | -| | acronym in parenthesis. | | -| | For all subsequent uses, | | -| | use the acronym. | | +| Acronyms | First instance, display definition as | Use the ``:abbr:`` role. | +| | flyover text in this format: | | +| | ``:abbr:`Acronym (Definition)``` | | +| | For subsequent uses, use the acronym. | | +--------------------------------+---------------------------------------+-----------------------------+ | Bundle names | Bold | Use the ``:command:`` role. | +--------------------------------+---------------------------------------+-----------------------------+ @@ -210,7 +210,7 @@ Use our quick reference for the most commonly used inline text elements: | Menu selection | | Use ``:menuselection:`` | +--------------------------------+---------------------------------------+-----------------------------+ | New terms | Italic for first use, normal for all | ``*term*`` | -| | subsequent use. | | +| | subsequent uses. | | | | | | | | If it is used outside of the source | | | | of definition, link the term. | | @@ -221,9 +221,9 @@ Use our quick reference for the most commonly used inline text elements: | Tool names | Correctly capitalized, no quotes, | | | | bold, or italics as the basic rule. | | | | | | -| | If it is a Linux tool e.g the tool | | -| | name is the command, treat it like | | -| | a command. | | +| | If the tool name is the command, like | | +| | most Linux tools, treat it like a | | +| | command. | | | | | | | | If the tool name is lowercase and | | | | used at the start of a sentence, use | |