diff options
author | Travis Oliphant <oliphant@enthought.com> | 2007-12-15 18:54:52 +0000 |
---|---|---|
committer | Travis Oliphant <oliphant@enthought.com> | 2007-12-15 18:54:52 +0000 |
commit | e76b5fa6896c09257181675bbf4cf47789d32927 (patch) | |
tree | 7174e22c68fc47df61e745ee18625ee9f4f5b88c /numpy/doc/example.py | |
parent | 02ee35a7e1c722a1cdac8f3a60fe9ef7aa079a37 (diff) | |
download | numpy-e76b5fa6896c09257181675bbf4cf47789d32927.tar.gz |
Create a branch for io work in NumPy
Diffstat (limited to 'numpy/doc/example.py')
-rw-r--r-- | numpy/doc/example.py | 98 |
1 files changed, 0 insertions, 98 deletions
diff --git a/numpy/doc/example.py b/numpy/doc/example.py deleted file mode 100644 index 26d140e5f..000000000 --- a/numpy/doc/example.py +++ /dev/null @@ -1,98 +0,0 @@ -"""This is the docstring for the example.py module. Modules names should -have short, all-lowercase names. The module name may have underscores if -this improves readability. - -Every module should have a docstring at the very top of the file. The -module's docstring may extend over multiple lines. If your docstring does -extend over multiple lines, the closing three quotation marks must be on -a line by itself, preferably preceeded by a blank line. - -""" - -import os # standard library imports first - -import numpy as np # related third party imports next -import scipy as sp # imports should be at the top of the module -import matplotlib as mpl # imports should usually be on separate lines - - -__docformat__ = "restructuredtext en" - - -def foo(var1, var2, long_var_name='hi') : - """One-line summary or signature. - - Several sentences providing an extended description. You can put - text in mono-spaced type like so: ``var``. - - *Parameters*: - - var1 : {array_like} - Array_like means all those objects -- lists, nested lists, etc. -- - that can be converted to an array. - var2 : {integer} - Write out the full type - long_variable_name : {'hi', 'ho'}, optional - Choices in brackets, default first when optional. - - *Returns*: - - named : {type} - Explanation - list - Explanation - of - Explanation - outputs - even more explaining - - *Other Parameters*: - - only_seldom_used_keywords : type - Explanation - common_parametrs_listed_above : type - Explanation - - *See Also*: - - `otherfunc` : relationship (optional) - - `newfunc` : relationship (optional) - - *Notes* - - Notes about the implementation algorithm (if needed). - - This can have multiple paragraphs as can all sections. - - *Examples* - - examples in doctest format - - >>> a=[1,2,3] - >>> [x + 3 for x in a] - [4, 5, 6] - - """ - - pass - - -def newfunc() : - """Do nothing. - - I never saw a purple cow. - - """ - - pass - - -def otherfunc() : - """Do nothing. - - I never hope to see one. - - """ - - pass |