Merge "[contributor] Minor edits"
This commit is contained in:
commit
de8226a094
@ -15,7 +15,7 @@ code blocks, vertical lists, and many others. All the source content formatted
|
||||
using RST is stored in files with the ``.rst`` extension.
|
||||
|
||||
To keep the documentation format consistent, follow the guidelines
|
||||
included in this chapter for all the RST source content. When in doubt
|
||||
included in this chapter for all the RST source content. When in doubt,
|
||||
use simpler formatting.
|
||||
|
||||
.. note::
|
||||
|
@ -11,7 +11,7 @@ side-by-side diffs on reviews.
|
||||
|
||||
.. note::
|
||||
|
||||
Exception to this rule is the content of code-block elements and links
|
||||
An exception to this rule is the content of code-block elements and links
|
||||
within the references.
|
||||
|
||||
When formatting a table that presupposes long lines of text, give
|
||||
|
@ -63,7 +63,7 @@ Consider using a variable list instead of:
|
||||
* An itemized list when your list has a regular pattern of key/value or
|
||||
term/definition pairs.
|
||||
|
||||
* A two column table where the first column lists items of a consistent type
|
||||
* A two-column table where the first column lists items of a consistent type
|
||||
and the second column describes the items.
|
||||
|
||||
**Input**
|
||||
|
@ -48,9 +48,9 @@ To link to some external locations, format the RST source as follows:
|
||||
format a web link as ``Link text <http://web-link.com>``
|
||||
wrapping it in backticks.
|
||||
|
||||
* Do not separate a link name from a link itself by defining the link in other
|
||||
place in your document. It prevents translated documents from using different
|
||||
links, for example, corresponding links to translated versions.
|
||||
* Do not separate the link name from the link itself by defining the link in
|
||||
another place in your document. It prevents translated documents from using
|
||||
different links, for example, corresponding links to translated versions.
|
||||
|
||||
**Input**
|
||||
|
||||
|
@ -30,7 +30,7 @@ the admonition directives described above.
|
||||
A note may contain bulleted or enumerated lists,
|
||||
as well as code blocks:
|
||||
|
||||
* first option,
|
||||
* First option,
|
||||
* ...
|
||||
|
||||
**Output**
|
||||
@ -40,9 +40,9 @@ the admonition directives described above.
|
||||
This is the text of a note admonition.
|
||||
This line is the continuation of the first line.
|
||||
|
||||
Note may contain bulleted or enumerated lists,
|
||||
A note may contain bulleted or enumerated lists,
|
||||
as well as code blocks:
|
||||
|
||||
* first option,
|
||||
* First option,
|
||||
* ...
|
||||
|
||||
|
@ -47,8 +47,8 @@ levels within one file using the following non-alphanumeric characters:
|
||||
Under- and overlines should be of the same length
|
||||
as that of the heading text.
|
||||
|
||||
Avoid using lower heading levels by information
|
||||
rewriting and reorganizing.
|
||||
Avoid using lower heading levels by rewriting and reorganizing the
|
||||
information.
|
||||
|
||||
.. seealso::
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user