diff options
Diffstat (limited to 'numpy/doc/example.py')
-rw-r--r-- | numpy/doc/example.py | 54 |
1 files changed, 30 insertions, 24 deletions
diff --git a/numpy/doc/example.py b/numpy/doc/example.py index 635e75d53..5240f4de7 100644 --- a/numpy/doc/example.py +++ b/numpy/doc/example.py @@ -8,10 +8,6 @@ extend over multiple lines, the closing three quotation marks must be on a line by itself, preferably preceeded by a blank line. """ -# Make sure this line is here such that epydoc 3 can parse the docstrings for -# auto-generated documentation. -__docformat__ = "restructuredtext en" - import os # standard library imports first import numpy as np # related third party imports next @@ -19,6 +15,8 @@ import scipy as sp # imports should be at the top of the module import matplotlib as mpl # imports should usually be on separate lines import matplotlib.pyplot as plt +from my_module import my_func, other_func + def foo(var1, var2, long_var_name='hi') : """One-line summary or signature. @@ -53,6 +51,11 @@ def foo(var1, var2, long_var_name='hi') : common_parametrs_listed_above : type Explanation + Raises + ------ + BadException + Because you shouldn't have done that. + See Also -------- otherfunc : relationship (optional) @@ -64,34 +67,37 @@ def foo(var1, var2, long_var_name='hi') : This can have multiple paragraphs as can all sections. - Examples - -------- - examples in doctest format + You may include some math: - >>> a=[1,2,3] - >>> [x + 3 for x in a] - [4, 5, 6] + .. math:: X(e^{j\omega } ) = x(n)e^{ - j\omega n} - """ + And even use a greek symbol like :math:`omega` inline. - pass + References + ---------- + Cite the relevant literature, e.g. [1]_. You may also cite these + references in the notes section above. + .. [1] O. McNoleg, "The integration of GIS, remote sensing, + expert systems and adaptive co-kriging for environmental habitat + modelling of the Highland Haggis using object-oriented, fuzzy-logic + and neural-network techniques," Computers & Geosciences, vol. 22, + pp. 585-588, 1996. -def newfunc() : - """Do nothing. + Examples + -------- + These are written in doctest format, and should illustrate how to + use the function. - I never saw a purple cow. + >>> a=[1,2,3] + >>> print [x + 3 for x in a] + [4, 5, 6] + >>> print "a\n\nb" + a + <BLANKLINE> + b """ pass - -def otherfunc() : - """Do nothing. - - I never hope to see one. - - """ - - pass |