[gnue] r7437 - in trunk/gnue-common/src: apps datasources datasources/drivers/Base definitions formatting/masks printing/barcodes printing/pdftable utils

[reinhard]

Author: reinhard
Date: 2005-04-20 11:18:41 -0500 (Wed, 20 Apr 2005)
New Revision: 7437

Modified:
   trunk/gnue-common/src/apps/GBaseApp.py
   trunk/gnue-common/src/datasources/GConditions.py
   trunk/gnue-common/src/datasources/GDataSource.py
   trunk/gnue-common/src/datasources/drivers/Base/Connection.py
   trunk/gnue-common/src/datasources/drivers/Base/RecordSet.py
   trunk/gnue-common/src/datasources/drivers/Base/ResultSet.py
   trunk/gnue-common/src/definitions/GObjects.py
   trunk/gnue-common/src/formatting/masks/InputMask.py
   trunk/gnue-common/src/printing/barcodes/Base.py
   trunk/gnue-common/src/printing/pdftable/pdftable.py
   trunk/gnue-common/src/printing/pdftable/sample.py
   trunk/gnue-common/src/utils/CaselessDict.py
   trunk/gnue-common/src/utils/TextUtils.py
Log:
Epydoc fixes.


Modified: trunk/gnue-common/src/apps/GBaseApp.py
===================================================================
--- trunk/gnue-common/src/apps/GBaseApp.py      2005-04-20 12:10:41 UTC (rev 
7436)
+++ trunk/gnue-common/src/apps/GBaseApp.py      2005-04-20 16:18:41 UTC (rev 
7437)
@@ -901,10 +901,10 @@
     reference cycle. 'repr' is either a string representation of an object
     holding the reference or None. 'propertyname' could be one of the
     following:
-      'name'    name of the property within 'repr' holding the reference
-      '[n]'     the reference is the n-th element of a sequence
-      '[name]'  the reference is the value of key 'name' in a dictionary
-      '{}'      the reference is a key in a dictionary
+      - 'name':   name of the property within 'repr' holding the reference
+      - '[n]':    the reference is the n-th element of a sequence
+      - '[name]': the reference is the value of key 'name' in a dictionary
+      - '{}':     the reference is a key in a dictionary
 
     The latter three variants could be cumulative (i.e. [1][3]['foo']) and the
     corresponding propertyname is the last one encountered.

Modified: trunk/gnue-common/src/datasources/GConditions.py
===================================================================
--- trunk/gnue-common/src/datasources/GConditions.py    2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/datasources/GConditions.py    2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -208,7 +208,7 @@
     Return the condition tree as SQL string in python-format using placeholders
     and a given parameter dictionary. 
     
-    Example:
+    Example::
       condition = ['eq', ['field', 'foobar'], ['const', 'barbaz']]
       result = condition.asSQL (pDict)
 

Modified: trunk/gnue-common/src/datasources/GDataSource.py
===================================================================
--- trunk/gnue-common/src/datasources/GDataSource.py    2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/datasources/GDataSource.py    2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -487,7 +487,7 @@
     The resultSet is passed as a parameter and need not be the current result
     set of the datasource.
 
-    @param masterRecordSet: The master record for which the detail should be
+    @param masterRecord: The master record for which the detail should be
       requeried.
     @param resultSet: The existing result set into which the changes should be
       merged.

Modified: trunk/gnue-common/src/datasources/drivers/Base/Connection.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/Base/Connection.py        
2005-04-20 12:10:41 UTC (rev 7436)
+++ trunk/gnue-common/src/datasources/drivers/Base/Connection.py        
2005-04-20 16:18:41 UTC (rev 7437)
@@ -227,7 +227,6 @@
       record (aka where-clause).
     @param methodname: Name of the function to call.
     @param parameters: parametername/value dictionary.
-    @param recno: Record number to be used in error messages.
     @return: Result of the function that was called.
     """
 
@@ -329,7 +328,7 @@
     Modify the database schema according to the given definition.
     
     @param definition: Sequence of table definitions.
-      @see: Schema.Creation.Creation
+      See L{Schema.Creation.Creation}.
     @param codeOnly: If True, only the code will be generated to modify the
       schema, no actions take place.
     @return: a tuple of three sequences (prologue, body, epilogue) holding the
@@ -603,7 +602,6 @@
       record (aka where-clause).
     @param methodname: Name of the function to call.
     @param parameters: parametername/value dictionary.
-    @param recno: Record number to be used in error messages.
     @return: Result of the function that was called.
     """
     pass

Modified: trunk/gnue-common/src/datasources/drivers/Base/RecordSet.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/Base/RecordSet.py 2005-04-20 
12:10:41 UTC (rev 7436)
+++ trunk/gnue-common/src/datasources/drivers/Base/RecordSet.py 2005-04-20 
16:18:41 UTC (rev 7437)
@@ -62,7 +62,7 @@
     @param tablename: Table name.
     @param rowidField: Field name of the field containing a unique row id
       generated by the backend, if available.
-    @param primaryKeyFields: List of field names that make up a unique key, if
+    @param primarykeyFields: List of field names that make up a unique key, if
       available.
     @param boundFields: List of fields to be included when posting changes to
       the backend. All fields not in this list are considered unbound fields

Modified: trunk/gnue-common/src/datasources/drivers/Base/ResultSet.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/Base/ResultSet.py 2005-04-20 
12:10:41 UTC (rev 7436)
+++ trunk/gnue-common/src/datasources/drivers/Base/ResultSet.py 2005-04-20 
16:18:41 UTC (rev 7437)
@@ -61,7 +61,7 @@
     @param tablename: Table name.
     @param rowidField: Field name of the field containing a unique row id
       generated by the backend, if available.
-    @param primaryKeyFields: List of field names that make up a unique key, if
+    @param primarykeyFields: List of field names that make up a unique key, if
       available.
     @param boundFields: List of fields to be included when posting changes to
       the backend. All fields not in this list are considered unbound fields
@@ -117,7 +117,7 @@
     Populate the resultset with data.
 
     @param type: Type of the query, can be 'object' or 'sql'.
-    @param **kwargs: Depends on the type.
+    @param kwargs: Depends on the type.
     """
 
     queryfunc = '_query_' + type

Modified: trunk/gnue-common/src/definitions/GObjects.py
===================================================================
--- trunk/gnue-common/src/definitions/GObjects.py       2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/definitions/GObjects.py       2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -81,7 +81,7 @@
 
     Typically called from within a GParser instance.  phaseInit interates
     thru the GObj tree as many times as necessary to fully initialize the
-    tree.  It determines the number of interations to perform during it's
+    tree.  It determines the number of iterations to perform during it's
     first pass down the tree.
 
     phaseInit looks for a private list variable called _inits that
@@ -102,9 +102,9 @@
     as the children may not be loaded yet or may not yet have the needed
     information.
     
-    @type interations: integer
-    @param interations: Limits the number of passes to the specified number.
-                        This doesn't appear to be used anywhere.
+    @type iterations: integer
+    @param iterations: Limits the number of passes to the specified number.
+                       This doesn't appear to be used anywhere.
     """
     if iterations == 0:
       iterations = self.maxInits()
@@ -237,7 +237,6 @@
                           the gnue-forms objects.  If set to None (the default)
                           then the behaviour will be the old style which
                           removes the first two characters from the type.
-    @type multipler: list of strings
     @return: The xml tag to use
     @rtype: string
     """

Modified: trunk/gnue-common/src/formatting/masks/InputMask.py
===================================================================
--- trunk/gnue-common/src/formatting/masks/InputMask.py 2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/formatting/masks/InputMask.py 2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -40,9 +40,8 @@
 
 class InputMask:
   """
-  All functions return a tuple containing:
-    (displayed representation, cursor position)
-
+  All functions return a tuple containing
+  (displayed representation, cursor position)
   or can raise InvalidInputCharacter
   """
 
@@ -121,7 +120,7 @@
     and sets the resultant display
     
     @type newtext:  string
-    @parma newtext: The text to add via the input mask
+    @param newtext: The text to add via the input mask
     """
 
     cursor = self.cursor

Modified: trunk/gnue-common/src/printing/barcodes/Base.py
===================================================================
--- trunk/gnue-common/src/printing/barcodes/Base.py     2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/printing/barcodes/Base.py     2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -99,21 +99,18 @@
     @param value:   The string to convert to a barcode
     @param stream:  Optional argument of file name as a string, or any
                     open file style object.
-    @param format: The format in which the output should be generated
-
+    @param format: The format in which the output should be generated.
                   Valid file formats include pdf, eps, svg and
                   will require the stream argument be provided.
-
                   Valid object formats include
-                    rldrawing: ReportLab Drawing object will be returned
-                                No stream argument is required.
+                  rldrawing (ReportLab Drawing object will be returned,
+                  No stream argument is required).
     @param includeText: Boolean.  If true then human readable text will
                         be printed centered under the barcode.
-
     @param textSize: The point size of the human readable text.
     @param dpi: The dots per inch at which the bitmap should be generated.
 
-    @return: None or a format dependent object.  Valid return values
+    @return: None or a format dependent object.  Valid return values::
             eps : None
             pdf : None
             svg : None

Modified: trunk/gnue-common/src/printing/pdftable/pdftable.py
===================================================================
--- trunk/gnue-common/src/printing/pdftable/pdftable.py 2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/printing/pdftable/pdftable.py 2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -122,10 +122,10 @@
     """
     A simple table based report generator.
     
-    The class provides the following features.
-      Border support for columns, rows.
-      Automatic adjustments of the data when it is unable to fit on one page.
-      Multiple sections of a report handled automatically.
+    The class provides the following features:
+      - Border support for columns, rows.
+      - Automatic adjustments of the data when it is unable to fit on one page.
+      - Multiple sections of a report handled automatically.
     
     @param file: A python file handle used for output
     @param parameterBox: Unused?

Modified: trunk/gnue-common/src/printing/pdftable/sample.py
===================================================================
--- trunk/gnue-common/src/printing/pdftable/sample.py   2005-04-20 12:10:41 UTC 
(rev 7436)
+++ trunk/gnue-common/src/printing/pdftable/sample.py   2005-04-20 16:18:41 UTC 
(rev 7437)
@@ -220,7 +220,7 @@
     """
     Simple function to generate random salesperson data for the sample report.
     
-    @param lines: The number of lines of salesperson data to generate
+    @param years: The number of lines of salesperson data to generate
     """
     import random
     names=['Tom Barker','Linda Carter','Willy Sellut','Peter Smith','Chilly 
Willy','Betty Bip',

Modified: trunk/gnue-common/src/utils/CaselessDict.py
===================================================================
--- trunk/gnue-common/src/utils/CaselessDict.py 2005-04-20 12:10:41 UTC (rev 
7436)
+++ trunk/gnue-common/src/utils/CaselessDict.py 2005-04-20 16:18:41 UTC (rev 
7437)
@@ -344,7 +344,7 @@
     This function returns an iterator over the mapping's keys. If Python
     version is below 2.2 this function raises a NotImplementedError.
 
-    @return iterator object for keys
+    @return: iterator object for keys
     """
 
     if sys.version_info [:2] >= (2, 2):
@@ -363,7 +363,7 @@
     This function returns an iterator over the mapping's values. If Python
     version is below 2.2 this function raises a NotImplementedError.
 
-    @return iterator object for values
+    @return: iterator object for values
     """
 
     if sys.version_info [:2] >= (2, 2):

Modified: trunk/gnue-common/src/utils/TextUtils.py
===================================================================
--- trunk/gnue-common/src/utils/TextUtils.py    2005-04-20 12:10:41 UTC (rev 
7436)
+++ trunk/gnue-common/src/utils/TextUtils.py    2005-04-20 16:18:41 UTC (rev 
7437)
@@ -112,7 +112,7 @@
   @type text: string
   @param multiplier: A multiplier used to adjust the output
                      to values other inches.
-  @type multipler: number
+  @type multiplier: number
 
   @return: The converted value
   @rtype: number