Skip to content

Commit fb3031f

Browse files
AaronWdaisylb
authored andcommitted
Attempting to fix markup...
1 parent 9a8f760 commit fb3031f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/writing/documentation.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,21 @@ Block comment styling should be used when commenting out multiple lines of code.
2222
single #.
2323

2424
Inline comments are used for individual lines and should be used sparingly.: ::
25+
2526
An inline comment is a comment on the same line as a statement. Inline
2627
comments should be separated by at least two spaces from the statement.
2728
They should start with a # and a single space.
2829
Inline comments are unnecessary and in fact distracting if they state
2930
the obvious. Don't do this:
3031
x = x + 1 # Increment x
31-
But sometimes, this is useful:
32+
But sometimes, this is useful: ::
3233
x = x + 1 # Compensate for border
3334

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

0 commit comments

Comments
 (0)