Attempting to fix markup...

This commit is contained in:
Aaron
2011-04-26 22:58:07 +08:00
committed by Adam Brenecki
parent 9a8f760530
commit fb3031f20d
+4 -3
View File
@@ -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."""