Skip to content

Commit

Permalink
Attempting to fix markup...
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronW committed Apr 26, 2011
1 parent d84ef20 commit 5eeea52
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/writing/documentation.rst
Expand Up @@ -22,20 +22,21 @@ Block comment styling should be used when commenting out multiple lines of code.
single #.

Inline comments are used for individual lines and should be used sparingly.: ::

An inline comment is a comment on the same line as a statement. Inline
comments should be separated by at least two spaces from the statement.
They should start with a # and a single space.
Inline comments are unnecessary and in fact distracting if they state
the obvious. Don't do this:
x = x + 1 # Increment x
But sometimes, this is useful:
But sometimes, this is useful: ::
x = x + 1 # Compensate for border

Doc Strings
-----------
PEP 257 is the primary reference for docstrings. (http://www.python.org/dev/peps/pep-0257/)
There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
One-line docstrings: ::
|There are two types of docstrings, one-line and multi-line. Their names should be fairly self explanatory.
|One-line docstrings: ::
def kos_root():
"""Return the pathname of the KOS root directory."""
Expand Down

0 comments on commit 5eeea52

Please sign in to comment.