Changeset 5345

Timestamp:

29 Jul 2010, 23:10:15 (14 years ago)

Author:

uli

Message:

Tell a bit more in docstrings.

File:

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

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

@@ -25 +25 @@
     """
     grok.implements(IUniversity)
+    
     # Setup authentication for this app. Note: this is only
     # initialized, when a new instance of this app is created.
@@ -30 +31 @@
         PluggableAuthentication, provides = IAuthentication,
         setup = setup_authentication,)
+
+    #: The name of the university.
+    name=u'Sample University'
     
     @property
     def logger(self):
+        """The application logger.
+
+        Returns a standard logger object as provided by :mod:`logging`
+        module from the standard library.
+        
+        Other components can use this logger to perform log entries
+        into the 'main' logfile.
+
+        The logger is initialized the first time, it is called.
+        """
         sitename = self.__name__
         loggername = 'waeup.sirp.%s' % sitename
@@ -47 +61 @@
 
     def setup(self):
+        """Setup some hard-wired components.
+
+        Create local datacenter, containers for users, students and
+        the like.
+        """
         self['users'] = UserContainer()
         self['datacenter'] = DataCenter()