diff options
Diffstat (limited to 'numpy/doc/example.py')
| -rw-r--r-- | numpy/doc/example.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/numpy/doc/example.py b/numpy/doc/example.py index cb5c24690..80da1edeb 100644 --- a/numpy/doc/example.py +++ b/numpy/doc/example.py @@ -1,3 +1,13 @@ +"""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. + +""" __docformat__ = "restructuredtext en" |