[gnue] r7606 - in trunk/gnue-common/src/datasources: . drivers/Base drivers/DBSIG2 drivers/mysql

[reinhard]

Author: reinhard
Date: 2005-06-17 01:59:18 -0500 (Fri, 17 Jun 2005)
New Revision: 7606

Modified:
   trunk/gnue-common/src/datasources/GDataSource.py
   trunk/gnue-common/src/datasources/drivers/Base/Connection.py
   trunk/gnue-common/src/datasources/drivers/DBSIG2/Behavior.py
   trunk/gnue-common/src/datasources/drivers/mysql/Behavior.py
Log:
Fixed a few docstrings.


Modified: trunk/gnue-common/src/datasources/GDataSource.py
===================================================================
--- trunk/gnue-common/src/datasources/GDataSource.py    2005-06-16 22:57:12 UTC 
(rev 7605)
+++ trunk/gnue-common/src/datasources/GDataSource.py    2005-06-17 06:59:18 UTC 
(rev 7606)
@@ -46,24 +46,24 @@
 
   Each GDataSource object maintains its own event controller and issues the
   following events:
-  - dsResultSetActivated (parameters: resultSet) whenever the current ResultSet
-    of this datasource changes; this happens when a query is executed or when
-    the master of this datasource moves to another record.
-  - dsResultSetChanged (parameters: resultSet) whenever the current ResultSet
-    has been reloaded from the backend; this happens after each commit if the
-    "requery" option of this datasource is in use.
-  - dsCursorMoved (parameters: none) whenever the cursor in the current
-    ResultSet is moved, i.e. a different record becomes the current record.
-  - dsRecordLoaded (parameters: record) whenever a record has been loaded from
-    the backend.
-  - dsRecordTouchend (parameters: record) whenever a record is modified for the
-    first time since it was loaded from the backend or last saved.
-  - dsCommitInsert (parameters: record) whenever a record is about to be
-    inserted in the backend due to a commit operation.
-  - dsCommitUpdate (parameters: record) whenever a record is about to be
-    updated in the backend due to a commit operation.
-  - dsCommitDelete (parameters: record) whenever a record is about to be
-    deleted in the backend due to a commit operation.
+    - dsResultSetActivated (parameters: resultSet) whenever the current
+      ResultSet of this datasource changes; this happens when a query is
+      executed or when the master of this datasource moves to another record.
+    - dsResultSetChanged (parameters: resultSet) whenever the current ResultSet
+      has been reloaded from the backend; this happens after each commit if the
+      "requery" option of this datasource is in use.
+    - dsCursorMoved (parameters: none) whenever the cursor in the current
+      ResultSet is moved, i.e. a different record becomes the current record.
+    - dsRecordLoaded (parameters: record) whenever a record has been loaded
+      from the backend.
+    - dsRecordTouchend (parameters: record) whenever a record is modified for
+      the first time since it was loaded from the backend or last saved.
+    - dsCommitInsert (parameters: record) whenever a record is about to be
+      inserted in the backend due to a commit operation.
+    - dsCommitUpdate (parameters: record) whenever a record is about to be
+      updated in the backend due to a commit operation.
+    - dsCommitDelete (parameters: record) whenever a record is about to be
+      deleted in the backend due to a commit operation.
   """
 
   # 
--------------------------------------------------------------------------- 

Modified: trunk/gnue-common/src/datasources/drivers/Base/Connection.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/Base/Connection.py        
2005-06-16 22:57:12 UTC (rev 7605)
+++ trunk/gnue-common/src/datasources/drivers/Base/Connection.py        
2005-06-17 06:59:18 UTC (rev 7606)
@@ -96,7 +96,7 @@
     tuples (label, value-dictionary) describing the allowed values (per
     master-field if any).
 
-    A typical return value would be:
+    A typical return value would be::
       [(_('User Name'), '_username', 'string', None, None, []),
        (_('Password'), '_password', 'password', None, None, [])]
     """

Modified: trunk/gnue-common/src/datasources/drivers/DBSIG2/Behavior.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/DBSIG2/Behavior.py        
2005-06-16 22:57:12 UTC (rev 7605)
+++ trunk/gnue-common/src/datasources/drivers/DBSIG2/Behavior.py        
2005-06-17 06:59:18 UTC (rev 7606)
@@ -280,12 +280,12 @@
   # Handle special kinds of default values (like functions, sequences, ...)
   # ---------------------------------------------------------------------------
 
-  def _defaultwith_ (self, result, field):
+  def _defaultwith_ (self, code, field):
     """
     Process special kinds of default values like sequences, functions and so
     on. Defaults of type 'constant' are already handled by '_processFields_'.
 
-    @param result: code-triple of the current field as built by _processFields_
+    @param code: code-triple of the current field as built by _processFields_
     @param field: GSField instance to process the default for
     """
 

Modified: trunk/gnue-common/src/datasources/drivers/mysql/Behavior.py
===================================================================
--- trunk/gnue-common/src/datasources/drivers/mysql/Behavior.py 2005-06-16 
22:57:12 UTC (rev 7605)
+++ trunk/gnue-common/src/datasources/drivers/mysql/Behavior.py 2005-06-17 
06:59:18 UTC (rev 7606)
@@ -34,15 +34,15 @@
   """
   Known bugs/problems:
 
-  1. MySQL does not support booleans, nor does it have column checks. So a
-     'boolean' column will be transformed into a 'number' silently.
+    1. MySQL does not support booleans, nor does it have column checks. So a
+       'boolean' column will be transformed into a 'number' silently.
 
-  2. MySQL does not give us a chance to find out anything about foreign key
-     constraints. (Even with InnoDB it's quite hard to parse it from SHOW
-     CREATE TABLE or SHOW TABLE STATUS)
+    2. MySQL does not give us a chance to find out anything about foreign key
+       constraints. (Even with InnoDB it's quite hard to parse it from SHOW
+       CREATE TABLE or SHOW TABLE STATUS)
 
-  3. MySQL does *not* store the name of a primary key, instead this is always
-     'PRIMARY'. That's why we lose the original primary key's names.
+    3. MySQL does *not* store the name of a primary key, instead this is always
+       'PRIMARY'. That's why we lose the original primary key's names.
   """
 
   _TYPEMAP = {'string'   : ('string', 'string'),
@@ -271,9 +271,7 @@
     fieldtype on 'timestamps'
 
     @param code: code-tuple to merge the result in
-    @param tableName: name of the table
-    @param fieldDef: dictionary describing the field with the default
-    @param forAlter: TRUE if the definition is used in a table modification
+    @param field: GSField instance to process the default for
     """
 
     if field.defaultwith == 'serial':