From 76ab788ef20cfae3417b3d9a8513d6df13acd839 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Sun, 23 Sep 2007 12:21:04 +0000 Subject: more documentation --- numpy/doc/example.py | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'numpy/doc/example.py') 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" -- cgit v1.2.1