[gnue] r6977 - trunk/gnue-common/src/datasources

[kilo]

Author: kilo
Date: 2005-02-08 07:17:36 -0600 (Tue, 08 Feb 2005)
New Revision: 6977

Modified:
   trunk/gnue-common/src/datasources/GDataSource.py
Log:
Added descriptions (aka "documentation")

Modified: trunk/gnue-common/src/datasources/GDataSource.py
===================================================================
--- trunk/gnue-common/src/datasources/GDataSource.py    2005-02-08 12:54:14 UTC 
(rev 6976)
+++ trunk/gnue-common/src/datasources/GDataSource.py    2005-02-08 13:17:36 UTC 
(rev 6977)
@@ -624,17 +624,23 @@
                'Typecast': GTypecast.name },
             'cache':       {
                'Label': _('Cache Size'),
+               'Description': 'Cache this number of records',
                'Typecast': GTypecast.whole,
                'Default':  5 },
             'prequery':    {
                'Label': _('Query on Startup'),
+               'Description': 'If true, the datasource is populated on '
+                              'form startup. If false (default), the form '
+                              'starts out with an empty record until the user '
+                              'or a trigger queries the database.',
                'Typecast': GTypecast.boolean,
                'Default':  False },
             'distinct':    {
                'Typecast': GTypecast.boolean,
                'Default':  False },
             'order_by':    {
-               'Typecast': GTypecast.text },
+               'Typecast': GTypecast.text ,
+               'Deprecated': 'Use {sortorder} tag instead' },
             'master':      {
                'Label': _('M/D Master DataSource'),
                'Description': 'If this datasource is the child in a '
@@ -697,9 +703,13 @@
           'name': {
             'Required': True,
             'Unique'  : True,
+            'Description': 'The name of the field by which the datasource '
+                           'will be ordered.',
             'Typecast': GTypecast.name,
             },
           'descending': {
+            'Description': 'Selects if the ordering is done ascending '
+                           '(default) or descending order.',
             'Default' : False,
             'Typecast': GTypecast.boolean,
           },