diff options
| author | Pauli Virtanen <pav@iki.fi> | 2009-07-01 20:19:18 +0000 |
|---|---|---|
| committer | Pauli Virtanen <pav@iki.fi> | 2009-07-01 20:19:18 +0000 |
| commit | d35eac6f1095727b430ca6416b76a9b43c715c1c (patch) | |
| tree | 756556030757225a89b50b1e47a9ae345752dceb /doc/example.py | |
| parent | 251e1db72fe90fb36af9e4eb13a38905cc3f55cd (diff) | |
| download | numpy-d35eac6f1095727b430ca6416b76a9b43c715c1c.tar.gz | |
Address #1146: update docstring standard
In addition, drop mentions of the index:: directive -- we are not using
it currently anywhere, and it does not work with Sphinx as-is.
Diffstat (limited to 'doc/example.py')
| -rw-r--r-- | doc/example.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/example.py b/doc/example.py index 152e2a622..0d5b53a33 100644 --- a/doc/example.py +++ b/doc/example.py @@ -35,7 +35,7 @@ import matplotlib.pyplot as plt from my_module import my_func, other_func def foo(var1, var2, long_var_name='hi') : - """A one-line summary that does not use variable names or the + r"""A one-line summary that does not use variable names or the function name. Several sentences providing an extended description. Refer to @@ -58,11 +58,11 @@ def foo(var1, var2, long_var_name='hi') : ------- describe : type Explanation - output + output : type Explanation - tuple + tuple : type Explanation - items + items : type even more explaining Other Parameters @@ -117,7 +117,6 @@ def foo(var1, var2, long_var_name='hi') : [4, 5, 6] >>> print "a\n\nb" a - <BLANKLINE> b """ |