[gnue] r9891 - in trunk/gnue-common/src: lib utils

[reinhard]

Author: reinhard
Date: 2008-07-31 07:52:58 -0500 (Thu, 31 Jul 2008)
New Revision: 9891

Modified:
   trunk/gnue-common/src/lib/iso8601.py
   trunk/gnue-common/src/utils/file.py
   trunk/gnue-common/src/utils/setup.py
Log:
Fixed epydoc syntax.


Modified: trunk/gnue-common/src/lib/iso8601.py
===================================================================
--- trunk/gnue-common/src/lib/iso8601.py        2008-07-30 08:16:46 UTC (rev 
9890)
+++ trunk/gnue-common/src/lib/iso8601.py        2008-07-31 12:52:58 UTC (rev 
9891)
@@ -158,18 +158,18 @@
     Parse a string containing any ISO 8601 conformant representation of a date.
 
     Basic formats:
-        * yyyymmdd (year, month, day)
-        * yyyymm (assumes first day of the month)
-        * yyyyWwwd (year, week number, day of week)
-        * yyyyWww (assumes first day of the week, that is Monday)
-        * yyyyddd (year, ordinal day in year)
+        - yyyymmdd (year, month, day)
+        - yyyymm (assumes first day of the month)
+        - yyyyWwwd (year, week number, day of week)
+        - yyyyWww (assumes first day of the week, that is Monday)
+        - yyyyddd (year, ordinal day in year)
 
     Extended formats:
-        * yyyy-mm-dd (year, month, day)
-        * yyyy-mm (assumes first day of the month)
-        * yyyy-Www-d (year, week number, day of week)
-        * yyyy-Www (assumes first day of the week, that is Monday)
-        * yyyy-ddd (year, ordinal day in year)
+        - yyyy-mm-dd (year, month, day)
+        - yyyy-mm (assumes first day of the month)
+        - yyyy-Www-d (year, week number, day of week)
+        - yyyy-Www (assumes first day of the week, that is Monday)
+        - yyyy-ddd (year, ordinal day in year)
 
     The extended formats tolerate missing leading zeroes.
 
@@ -257,25 +257,25 @@
     Parse a string containing any ISO 8601 conformant representation of a time.
 
     Basic formats:
-        * hhmm (hour, minute)
-        * hhmmss (hour, minute, seconds)
-        * hhmmss.fff (arbitary number of fractional digits)
-        * hhmmss,fff (arbitary number of fractional digits)
+        - hhmm (hour, minute)
+        - hhmmss (hour, minute, seconds)
+        - hhmmss.fff (arbitary number of fractional digits)
+        - hhmmss,fff (arbitary number of fractional digits)
 
     Extended formats:
-        * hh:mm (hour, minute)
-        * hh:mm:ss (hour, minute, seconds)
-        * hh:mm:ss.fff (arbitary number of fractional digits)
-        * hh:mm:ss,fff (arbitary number of fractional digits)
+        - hh:mm (hour, minute)
+        - hh:mm:ss (hour, minute, seconds)
+        - hh:mm:ss.fff (arbitary number of fractional digits)
+        - hh:mm:ss,fff (arbitary number of fractional digits)
 
     The extended formats tolerate missing leading zeroes.
 
     To each of the formats, one of the following timezone indicators can be
     appended:
-        * Z (for UTC)
-        * +hh or -hh
-        * +hhmm or -hhmm
-        * +hh:mm or -hh:mm
+        - Z (for UTC)
+        - +hh or -hh
+        - +hhmm or -hhmm
+        - +hh:mm or -hh:mm
 
     If a timezone indicator is used, the function yields a timezone aware time
     object, otherwise a naive time object.

Modified: trunk/gnue-common/src/utils/file.py
===================================================================
--- trunk/gnue-common/src/utils/file.py 2008-07-30 08:16:46 UTC (rev 9890)
+++ trunk/gnue-common/src/utils/file.py 2008-07-31 12:52:58 UTC (rev 9891)
@@ -59,8 +59,10 @@
     """
     Convert a string to a file object if it is not already.
 
+    Example 1:
         >>> to_buffer('This is text\nFoo.').read()
 
+    Example 2:
         >>> my_file = open('/etc/passwd')
         >>> to_buffer(my_file) == my_file
         >>> myfile.read()

Modified: trunk/gnue-common/src/utils/setup.py
===================================================================
--- trunk/gnue-common/src/utils/setup.py        2008-07-30 08:16:46 UTC (rev 
9890)
+++ trunk/gnue-common/src/utils/setup.py        2008-07-31 12:52:58 UTC (rev 
9891)
@@ -132,18 +132,18 @@
         after processing.  This method replaces the following strings by their
         corresponding values:
 
-          * :PACKAGE:  Name of the package, i.e. 'gnue-forms'
-          * :TITLE:    Title of the package, i.e. 'GNU Enterprise Forms'
-          * :VERSION:  Full version of the package, i.e. '0.6.9+svn.9794'
-          * :MAJOR:    The major version, i.e. '0'
-          * :MINOR:    The minor version, i.e. '6'
-          * :PHASE:    The phase, i.e. 'final'
-          * :BUILD:    The build, i.e. '1'
-          * :SVN:      The current SubVersion revision
-          * :DATE_ISO: The date of the package formatted as YYYY-MM-DD
-          * :DATE_RFC: The date of the package formatted according to RFC 822
-          * :TIME:     The time of the package formattes as HH:MM:SS
-          * :FINAL:    If the build is final it contains the build number,
+          - :PACKAGE:  Name of the package, i.e. 'gnue-forms'
+          - :TITLE:    Title of the package, i.e. 'GNU Enterprise Forms'
+          - :VERSION:  Full version of the package, i.e. '0.6.9+svn.9794'
+          - :MAJOR:    The major version, i.e. '0'
+          - :MINOR:    The minor version, i.e. '6'
+          - :PHASE:    The phase, i.e. 'final'
+          - :BUILD:    The build, i.e. '1'
+          - :SVN:      The current SubVersion revision
+          - :DATE_ISO: The date of the package formatted as YYYY-MM-DD
+          - :DATE_RFC: The date of the package formatted according to RFC 822
+          - :TIME:     The time of the package formattes as HH:MM:SS
+          - :FINAL:    If the build is final it contains the build number,
                        otherwise '0'
         """