[Numpy-svn] r4088 - trunk/numpy/doc

numpy-svn@scip... numpy-svn@scip...
Sun Sep 23 07:21:06 CDT 2007


Author: jarrod.millman
Date: 2007-09-23 07:21:04 -0500 (Sun, 23 Sep 2007)
New Revision: 4088

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
   trunk/numpy/doc/example.py
Log:
more documentation


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-09-23 11:53:11 UTC (rev 4087)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-09-23 12:21:04 UTC (rev 4088)
@@ -98,7 +98,7 @@
 Common reST concepts
 --------------------
 
-A reST-documented module should define
+A reST-documented module should define::
 
   __docformat__ = 'restructuredtext en'
 
@@ -118,9 +118,15 @@
 
 A more extensive example of reST markup can be found here:
 http://docutils.sourceforge.net/docs/user/rst/demo.txt
-An example follows. Line spacing and indentation are significant and should
+Line spacing and indentation are significant and should
 be carefully followed.
 
+Here is a short example in plain text:
+http://svn.scipy.org/svn/numpy/trunk/numpy/doc/example.py
+Here is the rendered version of that file:
+http://www.scipy.org/scipy/numpy/wiki/RenderedExample
+
+
 Using Epydoc
 ------------
 
@@ -149,8 +155,8 @@
 
 The first line of the signature should **not** copy the signature unless
 the function is written in C, in which case it is mandatory.  If the function
-signature is generic (uses *args or **kwds), then a function signature may be
-included.
+signature is generic (uses ``*args`` or ``**kwds``), then a function signature
+may be included.
 
 Use optional in the "type" field for parameters that are non-keyword
 optional for C-functions.

Modified: trunk/numpy/doc/example.py
===================================================================
--- trunk/numpy/doc/example.py	2007-09-23 11:53:11 UTC (rev 4087)
+++ trunk/numpy/doc/example.py	2007-09-23 12:21:04 UTC (rev 4088)
@@ -1,4 +1,14 @@
+"""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"
 
 



More information about the Numpy-svn mailing list