Ignore:
Timestamp:
21 Feb 2011, 07:24:25 (14 years ago)
Author:
uli
Message:

Be more verbose.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r5753 r5772  
    2222"""WAeUP SIRP support for JAMB tables.
    2323
    24 JAMB tables are datasets delivered by JAMB.
     24JAMB tables are datasets delivered by JAMB, normally as CSV files.
    2525"""
    2626import csv
    … …  
    4040
    4141class JAMBDataRoot(grok.Container):
     42    """A root folder for JAMB data.
     43
     44    JAMB data is normally imported as a set of
     45    :class:`waeup.sirp.applicants.applicants.Applicant` instances, but
     46    this depends on the importer used which is not part of the
     47    container itself.
     48
     49    The :class:`JAMBDataRoot` makes no special assumptions about how
     50    data is stored inside, while we should keep in mind that regular
     51    strings are the most effective way to store/retrieve data inside a
     52    :class:`grok.Container`.
     53
     54    In a regular 'waeup.sirp' site we normally provide a
     55    `JAMBDataRoot` instance named ``jambdata`` in the site
     56    root. I.e. when you create a :class:`waeup.sirp` university
     57    instance, a `JAMBDataRoot` is created automatically (by
     58    :class:`JAMBDataPlugin`) under the name ``jambdata``.
     59   
     60    .. seealso:: waeup.sirp.applicant.jambdata.batching.JAMBDataImporter
     61    """
    4262    grok.implements(IJAMBDataRoot)
    4363   
Note: See TracChangeset for help on using the changeset viewer.