Changeset 5772 for main/waeup.sirp/trunk

Timestamp:

21 Feb 2011, 07:24:25 (14 years ago)

Author:

uli

Message:

Be more verbose.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/applicants/jambtables/jambtables.py (modified) (2 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/applicants/jambtables/jambtables.py

@@ -22 +22 @@
 """WAeUP SIRP support for JAMB tables.
 
-JAMB tables are datasets delivered by JAMB.
+JAMB tables are datasets delivered by JAMB, normally as CSV files.
 """
 import csv
@@ -40 +40 @@
 
 class JAMBDataRoot(grok.Container):
+    """A root folder for JAMB data.
+
+    JAMB data is normally imported as a set of
+    :class:`waeup.sirp.applicants.applicants.Applicant` instances, but
+    this depends on the importer used which is not part of the
+    container itself.
+
+    The :class:`JAMBDataRoot` makes no special assumptions about how
+    data is stored inside, while we should keep in mind that regular
+    strings are the most effective way to store/retrieve data inside a
+    :class:`grok.Container`.
+
+    In a regular 'waeup.sirp' site we normally provide a
+    `JAMBDataRoot` instance named ``jambdata`` in the site
+    root. I.e. when you create a :class:`waeup.sirp` university
+    instance, a `JAMBDataRoot` is created automatically (by
+    :class:`JAMBDataPlugin`) under the name ``jambdata``.
+    
+    .. seealso:: waeup.sirp.applicant.jambdata.batching.JAMBDataImporter
+    """
     grok.implements(IJAMBDataRoot)