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

numpy-svn@scip... numpy-svn@scip...
Tue Jun 17 08:06:22 CDT 2008


Author: stefan
Date: 2008-06-17 08:06:08 -0500 (Tue, 17 Jun 2008)
New Revision: 5290

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Update documentation standard.


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-06-17 02:17:34 UTC (rev 5289)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2008-06-17 13:06:08 UTC (rev 5290)
@@ -339,7 +339,29 @@
     <http://www.scipy.org/Developer_Zone/ReferenceGuide>`_ is
     available.
 
+Documenting classes
+-------------------
 
+Class docstring
+```````````````
+Use the same sections as outlined above (all except ``Returns`` are
+applicable).  The constructor (``__init__``) should also be documented
+here.
+
+An ``Attributes`` section may be used to describe class variables::
+
+  Attributes
+  ----------
+  x : float
+      The X coordinate.
+  y : float
+      The Y coordinate.
+
+Method docstrings
+`````````````````
+Document these as you would any other function.  Do not include
+``self`` in the list of parameters.
+
 Common reST concepts
 --------------------
 For paragraphs, indentation is significant and indicates indentation in the



More information about the Numpy-svn mailing list