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

numpy-svn@scip... numpy-svn@scip...
Tue Oct 2 01:17:51 CDT 2007


Author: jarrod.millman
Date: 2007-10-02 01:17:47 -0500 (Tue, 02 Oct 2007)
New Revision: 4145

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


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-10-02 04:07:12 UTC (rev 4144)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-10-02 06:17:47 UTC (rev 4145)
@@ -1,12 +1,26 @@
-=================================
-A Guide to NumPy/SciPy Docstrings
-=================================
+====================================
+A Guide to NumPy/SciPy Documentation
+====================================
 
 .. Contents::
 
 Overview
 --------
+In general, we follow the standard Python style conventions as described here:
+ * `Style Guide for C Code <http://www.python.org/peps/pep-0007.html>`__
+ * `Style Guide for Python Code <http://www.python.org/peps/pep-0008.html>`__
+ * `Docstring Conventions <http://www.python.org/peps/pep-0257.html>`__
 
+Additional PEPs of interest regarding documentation of code:
+ * Docstring Processing System Framework <http://www.python.org/peps/pep-0256.html>`__
+ * Docutils Design Specification <http://www.python.org/peps/pep-0258.html>`__
+
+Use a code checker:
+ * `pylint <http://www.logilab.org/857>`__
+
+Docstring Standard
+------------------
+
 A documentation string (docstring) is a string that describes a module,
 function, class, or method definition.  The docstring is a special attribute
 of the object (``object.__doc__``) and, for consistency, is surrounded by



More information about the Numpy-svn mailing list