[Numpy-svn] r5294 - trunk/numpy/doc
numpy-svn at scipy.org
numpy-svn at scipy.org
Wed Jun 18 11:32:05 EDT 2008
Author: stefan
Date: 2008-06-18 10:31:50 -0500 (Wed, 18 Jun 2008)
New Revision: 5294
Modified:
trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Add `Methods` section to documentation standard.
Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt 2008-06-18 15:22:24 UTC (rev 5293)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt 2008-06-18 15:31:50 UTC (rev 5294)
@@ -357,6 +357,34 @@
y : float
The Y coordinate.
+In general, it is not necessary to list class methods. Those that are
+not part of the public API have names that start with an underscore.
+In some cases, however, a class may have a great many methods, of
+which only a few are relevant (e.g., subclasses of ndarray). Then, it
+becomes useful to have an additional ``Methods`` section::
+
+ class Photo(ndarray):
+ """
+ Array with associated photographic information.
+
+ ...
+
+ Attributes
+ ----------
+ exposure : float
+ Exposure in seconds.
+
+ Methods
+ -------
+ colorspace(c='rgb')
+ Represent the photo in the given colorspace.
+ gamma(n=1.0)
+ Change the photo's gamma exposure.
+
+ """
+
+Note that `self` is *not* listed as the first parameter of methods.
+
Method docstrings
`````````````````
Document these as you would any other function. Do not include
More information about the Numpy-svn
mailing list