[CalendarServer-changes] [7885] CalendarServer/branches/users/glyph/imip-and-admin-html/ twistedcaldav/mail.py

[source_changes at macosforge.org]

Revision: 7885
          http://trac.macosforge.org/projects/calendarserver/changeset/7885
Author:   glyph at apple.com
Date:     2011-08-11 21:37:19 -0700 (Thu, 11 Aug 2011)
Log Message:
-----------
getEventDetails docstring

Modified Paths:
--------------
    CalendarServer/branches/users/glyph/imip-and-admin-html/twistedcaldav/mail.py

Modified: CalendarServer/branches/users/glyph/imip-and-admin-html/twistedcaldav/mail.py
===================================================================
--- CalendarServer/branches/users/glyph/imip-and-admin-html/twistedcaldav/mail.py	2011-08-12 04:37:08 UTC (rev 7884)
+++ CalendarServer/branches/users/glyph/imip-and-admin-html/twistedcaldav/mail.py	2011-08-12 04:37:19 UTC (rev 7885)
@@ -1368,13 +1368,31 @@
 
 
     def getEventDetails(self, calendar, language='en'):
+        """
+        Create a dictionary mapping slot names - specifically: summary,
+        description, location, dateInfo, timeInfo, durationInfo, recurrenceInfo
+        - with localized string values that should be placed into the HTML and
+        plain-text templates.
 
+        @param calendar: a L{Component} upon which to base the language.
+
+        @type calendar: L{Component}
+
+        @param language: a 2-letter language code.
+
+        @type language: C{str}
+
+        @return: a mapping from template slot name to localized text.
+
+        @rtype: a C{dict} mapping C{bytes} to C{unicode}.
+        """
+
         # Get the most appropriate component
         component = calendar.masterComponent()
         if component is None:
             component = calendar.mainComponent(True)
 
-        results = { }
+        results = {}
 
         dtStart = component.propertyValue("DTSTART")
         results['month'] = dtStart.getMonth()
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20110811/cf4350c1/attachment.html>