Changeset 6495 for main/waeup.sirp/trunk/src/waeup/sirp

Timestamp:

2 Jul 2011, 01:54:19 (13 years ago)

Author:

uli

Message:

Some more docs.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.py

@@ -1 +1 @@
 """Components to handle access codes.
+
+Access codes (aka PINs) in waeup sites are organized in batches. That
+means a certain accesscode must be part of a batch. As a site (or
+university) can hold an arbitrary number of batches, we also provide a
+batch container. Each university has one batch container that holds
+all access code batches of which each one can hold several thousands
+of access codes.
 """
 import csv
@@ -17 +24 @@
 
 class AccessCode(grok.Model):
+    """An access code (aka PIN).
+    """
     grok.implements(IAccessCode)
 
@@ -57 +66 @@
     @property
     def history(self):
+        """A :class:`waeup.sirp.objecthistory.ObjectHistory` instance.
+        """
         history = IObjectHistory(self)
         return '||'.join(history.messages)