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

numpy-svn@scip... numpy-svn@scip...
Wed Aug 29 10:16:34 CDT 2007


Author: charris
Date: 2007-08-29 10:16:32 -0500 (Wed, 29 Aug 2007)
New Revision: 4020

Modified:
   trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Add blank lines between list items. This may be controversial because the result
is less compact, but I think it reads better on a terminal. Add bit about
putting alternative values for keyword arguments in curly brackets, default
first.


Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-08-28 22:26:59 UTC (rev 4019)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt	2007-08-29 15:16:32 UTC (rev 4020)
@@ -103,7 +103,7 @@
 __docformat__ = "restructuredtext en"
 
 
-def foo(var1, var2, long_var_name) :
+def foo(var1, var2, long_var_name='hi') :
     """One-line summary or signature.
 
     Several sentences providing an extended description. You can put
@@ -113,19 +113,24 @@
 
         var1 : type information
             Explanation
+
         var2 : type information
             Explanation
-        long_variable_name
-            Explanation
 
+        long_variable_name : {'hi', 'ho'}, optional
+            Choices in brackets, default first.
+
     *Returns*:
 
         named : type
             Explanation
+
         list
             Explanation
+
         of
             Explanation
+
         outputs
             even more explaining
 
@@ -133,14 +138,15 @@
 
         only_seldom_used_keywords : type
             Explanation
+
         common_parametrs_listed_above : type
             Explanation
 
     *See Also*:
 
-      `otherfunc` : relationship (optional)
+        `otherfunc` : relationship (optional)
 
-      `newfunc` : relationship (optional)
+        `newfunc` : relationship (optional)
 
     *Notes*
 



More information about the Numpy-svn mailing list