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

[kilo]

Author: kilo
Date: 2005-02-11 05:41:11 -0600 (Fri, 11 Feb 2005)
New Revision: 6999

Modified:
   trunk/gnue-common/src/datasources/GDataSource.py
Log:
Added documentation

Modified: trunk/gnue-common/src/datasources/GDataSource.py
===================================================================
--- trunk/gnue-common/src/datasources/GDataSource.py    2005-02-11 11:06:42 UTC 
(rev 6998)
+++ trunk/gnue-common/src/datasources/GDataSource.py    2005-02-11 11:41:11 UTC 
(rev 6999)
@@ -18,17 +18,11 @@
 #
 # Copyright 2000-2005 Free Software Foundation
 #
-# FILE:
-# GDataSource.py
-#
-# DESCRIPTION:
+# $Id$
+
 """
 Class that implements a provider-independent DataSource object
 """
-# NOTES:
-#
-# HISTORY:
-#
 
 from gnue.common.apps import i18n, errors
 from gnue.common.datasources import GDataObjects
@@ -614,24 +608,32 @@
       'datasource': {
          'BaseClass': GDataSource,
          'Importable': True,
+         'Description': 'A datasource provides a link to a database table '
+                        'or some similar data store.',
          'Attributes': {
             'name':        {
                'Required': True,
                'Unique':   True,
-               'Typecast': GTypecast.name },
+               'Typecast': GTypecast.name,
+               'Description': 'Unique name of the datasource.' },
             'type':        {
                'Label': _('Data Object Type'),
                'Typecast': GTypecast.name,
                'Default':  "object" },
             'connection':    {
                'Label': _('Connection Name'),
-               'Typecast': GTypecast.name },
+               'Typecast': GTypecast.name,
+               'Description': 'The name of the connection as in '
+                              'connections.conf that points to '
+                              'a valid database.' },
             'database':    {
                'Typecast': GTypecast.name,
                'Deprecated': 'Use {connection} attribute instead' },
             'table':       {
                'Label': _('Table Name'),
-               'Typecast': GTypecast.name },
+               'Typecast': GTypecast.name,
+               'Description': 'The table in the database this datasource '
+                              'will point to.' },
             'cache':       {
                'Label': _('Cache Size'),
                'Description': 'Cache this number of records',
@@ -647,7 +649,8 @@
                'Default':  False },
             'distinct':    {
                'Typecast': GTypecast.boolean,
-               'Default':  False },
+               'Default':  False,
+               'Description': 'TODO' },
             'order_by':    {
                'Typecast': GTypecast.text ,
                'Deprecated': 'Use {sortorder} tag instead' },
@@ -676,8 +679,8 @@
             # TODO: Short-term hack
             'explicitfields': {
                'Label': _('Explicit Fields'),
-
-               'Typecast': GTypecast.text },
+               'Typecast': GTypecast.text,
+               'Description': 'TODO' },
             'primarykey': {
                'Label': _('Primary Key Field(s)'),
                'Description': 'Comma-separated list of the fields that '
@@ -718,8 +721,8 @@
             'Typecast': GTypecast.name,
             },
           'descending': {
-            'Description': 'Selects if the ordering is done ascending '
-                           '(default) or descending order.',
+            'Description': 'Selects if the ordering is done in ascending '
+                           '(default) or in descending order.',
             'Default' : False,
             'Typecast': GTypecast.boolean,
           },


Property changes on: trunk/gnue-common/src/datasources/GDataSource.py
___________________________________________________________________
Name: svn:keywords
   - +Id
   + Id