valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 01:18:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #28908 from rallytime/doc-convention-spelling

Browse Source 
A couple of spelling fixes for doc conventions page.
This commit is contained in:
Mike Place 2015-11-15 19:29:34 -07:00
commit 2488b873b8
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/topics/development/conventions/documentation.rst
View File

@ -5,7 +5,7 @@ Writing Salt Documentation
==========================
Salt's documentation is built using the `Sphinx`_ documentation system. It can
be build in a large variety of output formats including HTML, PDF, ePub, and
be built in a large variety of output formats including HTML, PDF, ePub, and
manpage.
All the documentation is contained in the main Salt repository. Speaking
@ -72,7 +72,7 @@ Serial Commas
According to Wikipedia: In English punctuation, a serial comma or series comma
(also called Oxford comma and Harvard comma) is a comma placed immediately
before the coordinating conjunction (usually and, or, or nor) in a series of
before the coordinating conjunction (usually "and", "or", or "nor") in a series of
three or more terms. For example, a list of three countries might be punctuated
either as "France, Italy, and Spain" (with the serial comma), or as "France,
Italy and Spain" (without the serial comma)."
@ -96,7 +96,7 @@ code and can contain special formatting. For example:
.. code-block:: python
def myfunction(value):
def my_function(value):
'''
Upper-case the given value
@ -121,7 +121,7 @@ denotes what Salt release will be affected. For example:
.. code-block:: python
def myfunction(value):
def my_function(value):
'''
Upper-case the given value
@ -135,7 +135,7 @@ For changes to a function:
.. code-block:: python
def myfunction(value, strip=False):
def my_function(value, strip=False):
'''
Upper-case the given value
@ -200,7 +200,7 @@ a document.
Index entries
-------------
Sphinx automatically generates many kind of index entries but it is
Sphinx automatically generates many kinds of index entries, but it is
occasionally useful to manually add items to the index.
One method is to use the `index directive`_ above the document or section that
@ -309,13 +309,13 @@ branch instead of making all documentation changes against Salt's main, default
branch, ``develop``, is necessary in order for the docs to be as up-to-date as
possible when the docs are built.
The workflow mentioned above is also inline with the recommendations outlined
The workflow mentioned above is also in line with the recommendations outlined
in Salt's :ref:`contributing` page. You can read more about how to choose where
to submit documentation fixes by reading the :ref:`which-salt-branch` section.
For an explanation of how to submit changes against various branches, see the
:ref:`github-pull-request` section. Specifically, see the section describing
how to``Create a new branch`` and the steps that follow.
how to ``Create a new branch`` and the steps that follow.
.. _docs-building:
@ -337,7 +337,7 @@ Building the documentation
3. The generated documentation will be written to the ``doc/_build/<format>``
directory.
4. A useful method of viewing the HTML documentation locally is the start
4. A useful method of viewing the HTML documentation locally is to start
Python's built-in HTTP server:
.. code-block:: bash