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

Timestamp:

12 Feb 2011, 14:47:57 (14 years ago)

Author:

uli

Message:

Add doctest for getName.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/utils/helpers.py (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/utils/helpers.py

@@ -95 +95 @@
 def getName(context):
     """Construct a name out of an object with prefix and title.
+
+    The `context` has to provide `title_prefix` and `title`
+    attributes.
+
+        >>> from waeup.sirp.utils.helpers import getName
+        >>> class FakeObject(object):
+        ...     title_prefix = 'department'
+        ...     title = 'Strange Things'
+        >>> getName(FakeObject())
+        'Department of Strange Things'
+
+    As we can see in the result the `title_prefix` is rendered
+    uppercase.
+        
     """
     prefix = context.title_prefix