Changeset 13132 for main/waeup.kofa/trunk/src/waeup

Timestamp:

1 Jul 2015, 21:01:34 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• students/utils.py (modified) (2 diffs)
• utils/utils.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/students/utils.py

@@ -912 +912 @@
 
     def getBedCoordinates(self, bedticket):
-        """Return bed coordinates.
+        """Return descriptive bed coordinates.
         This method can be used to customize the `display_coordinates`
-        property method.
+        property method in order to  display a
+        customary description of the bed space.
         """
         return bedticket.bed_coordinates
@@ -928 +929 @@
         return None
 
+    #: A dictionary which maps widget names to headlines. The headline
+    #: is rendered in forms and on pdf slips above the respective
+    #: display or input widget. There are no separating headlines
+    #: in the base package.
     SEPARATORS_DICT = {}
 
+    #: A tuple containing names of file upload viewlets which are not shown
+    #: on the `StudentClearanceManageFormPage`. Nothing is being skipped
+    #: in the base package. This attribute makes only sense, if intermediate
+    #: custom packages are being used, like we do for all Nigerian portals.
     SKIP_UPLOAD_VIEWLETS = ()
 
+    #: A tuple containing the names of registration states in which changing of
+    #: passport pictures is allowed.
     PORTRAIT_CHANGE_STATES = (ADMITTED,)
 

main/waeup.kofa/trunk/src/waeup/kofa/utils/utils.py

@@ -82 +82 @@
     """
     grok.implements(IKofaUtils)
-    # This the only place where we define the portal language
-    # which is used for the translation of system messages
-    # (e.g. object histories).
+
+    #: This the only place where we define the portal language
+    #: which is used for the translation of system messages
+    #: (e.g. object histories) pdf slips.
     PORTAL_LANGUAGE = 'en'
 
@@ -209 +210 @@
     #: Set positive number for allowed max, negative for required min
     #: avail.
-    #:
     #: Use integer for bytes value, float for percent
     #: value. `cpu-load`, of course, accepts float values only.