openstack/openstack-manuals
Code Issues Proposed changes

Merge "[contributor] Minor edits"

Browse Source
This commit is contained in:
Jenkins 2016-07-07 11:03:02 +00:00 committed by Gerrit Code Review
commit de8226a094
6 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/contributor-guide/source/rst-conv.rst
View File

@ -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. using RST is stored in files with the ``.rst`` extension.
To keep the documentation format consistent, follow the guidelines 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. use simpler formatting.
.. note:: .. note::

2
doc/contributor-guide/source/rst-conv/gen-guidelines.rst
View File

@ -11,7 +11,7 @@ side-by-side diffs on reviews.
.. note:: .. 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. within the references.
When formatting a table that presupposes long lines of text, give When formatting a table that presupposes long lines of text, give

2
doc/contributor-guide/source/rst-conv/lists.rst
View File

@ -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 * An itemized list when your list has a regular pattern of key/value or
term/definition pairs. 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. and the second column describes the items.
**Input** **Input**

6
doc/contributor-guide/source/rst-conv/refs.rst
View File

@ -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>`` format a web link as ``Link text <http://web-link.com>``
wrapping it in backticks. wrapping it in backticks.
* Do not separate a link name from a link itself by defining the link in other * Do not separate the link name from the link itself by defining the link in
place in your document. It prevents translated documents from using different another place in your document. It prevents translated documents from using
links, for example, corresponding links to translated versions. different links, for example, corresponding links to translated versions.
**Input** **Input**

6
doc/contributor-guide/source/rst-conv/spec-info.rst
View File

@ -30,7 +30,7 @@ the admonition directives described above.
A note may contain bulleted or enumerated lists, A note may contain bulleted or enumerated lists,
as well as code blocks: as well as code blocks:
* first option, * First option,
* ... * ...
**Output** **Output**
@ -40,9 +40,9 @@ the admonition directives described above.
This is the text of a note admonition. This is the text of a note admonition.
This line is the continuation of the first line. 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: as well as code blocks:
* first option, * First option,
* ... * ...

4
doc/contributor-guide/source/rst-conv/titles.rst
View File

@ -47,8 +47,8 @@ levels within one file using the following non-alphanumeric characters:
Under- and overlines should be of the same length Under- and overlines should be of the same length
as that of the heading text. as that of the heading text.
Avoid using lower heading levels by information Avoid using lower heading levels by rewriting and reorganizing the
rewriting and reorganizing. information.
.. seealso:: .. seealso::