Changeset 13124 for main/waeup.kofa/trunk/src/waeup/kofa/utils

Timestamp:

1 Jul 2015, 16:24:58 (10 years ago)

Author:

Henrik Bettermann

Message:

More docs.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/utils/utils.py (modified) (6 diffs)

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

@@ -80 +80 @@
 class KofaUtils(grok.GlobalUtility):
     """A collection of parameters and methods subject to customization.
-
     """
     grok.implements(IKofaUtils)
@@ -242 +241 @@
     @property
     def tzinfo(self):
+        """Time zone of the university.
+        """
         # For Nigeria: pytz.timezone('Africa/Lagos')
         # For Germany: pytz.timezone('Europe/Berlin')
@@ -247 +248 @@
 
     def fullname(self, firstname, lastname, middlename=None):
-        """Full name constructor.
+        """Construct fullname.
         """
         # We do not necessarily have the middlename attribute
@@ -263 +264 @@
 
     def sendCredentials(self, user, password=None, url_info=None, msg=None):
-        """Send credentials as email.
-
-        Input is the applicant for which credentials are sent and the
-        password.
-
-        Returns True or False to indicate successful operation.
+        """Send credentials as email. Input is the user for which credentials
+        are sent and the password. Method returns True or False to indicate
+        successful operation.
         """
         subject = 'Your Kofa credentials'
@@ -308 +306 @@
 
     def getPaymentItem(self, payment):
-        """Return payment item.
-
-        This method can be used to customize the display_item property method.
+        """Return payment item. This method can be used to customize the
+        `display_item` property attribute, e.g. in order to hide bed coordinates
+        if maintenance fee is not paid.
         """
         return payment.p_item
@@ -316 +314 @@
     def expensive_actions_allowed(self, type=None, request=None):
         """Tell, whether expensive actions are currently allowed.
-
         Check system load/health (or other external circumstances) and
         locally set values to see, whether expensive actions should be
         allowed (`True`) or better avoided (`False`).
-
         Use this to allow or forbid exports, report generations, or
         similar actions.