[Epydoc-commits] SF.net SVN: epydoc: [1528] trunk/epydoc/doc/fields.html

[<dva...@us...>]

Revision: 1528
          http://svn.sourceforge.net/epydoc/?rev=1528&view=rev
Author:   dvarrazzo
Date:     2007-02-18 03:20:10 -0800 (Sun, 18 Feb 2007)

Log Message:
-----------
- Documented the fact that consolidated list don't require the term
  being interpreted text

Modified Paths:
--------------
    trunk/epydoc/doc/fields.html

Modified: trunk/epydoc/doc/fields.html
===================================================================
--- trunk/epydoc/doc/fields.html	2007-02-17 16:24:07 UTC (rev 1527)
+++ trunk/epydoc/doc/fields.html	2007-02-18 11:20:10 UTC (rev 1528)
@@ -665,7 +665,7 @@
 href="http://docutils.sourceforge.net/docs/user/rst/quickref.html#inline-markup">interpreted
 text</a>, and followed by a colon or dash.  If a consolidated field is
 written as a definition list, then each definition item's term should
-contain the field's argument, marked as interpreted text.  The term
+contain the field's argument, (it is not mandatory for it being marked as interpreted text).  The term
 classifier, if present, is used to specify the associated type.  The
 following example shows the use of a definition list to define a
 consolidated field.  (Note that docutils requires a space before and
@@ -678,11 +678,11 @@
     Return the maximum speed for a fox.
 
     <code class="field">:Parameters:</code>
-      `size`
+      size
           The size of the fox (in meters)
-      `weight` : float
+      weight : float
           The weight of the fox (in stones)
-      `age` : int
+      age : int
           The age of the fox (in years)
     """</code>
     <i>[...]</i>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.