# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1296338760 -3600
# Node ID 532d38e18f027f97536464a40d3970277053fff1
# Parent  949356c44be953e1446733c32ba2af5e52991168
Added various docstrings.

diff -r 949356c44be9 -r 532d38e18f02 macros/EventAggregator.py
--- a/macros/EventAggregator.py	Fri Jan 21 00:51:35 2011 +0100
+++ b/macros/EventAggregator.py	Sat Jan 29 23:06:00 2011 +0100
@@ -150,6 +150,12 @@
         return EventAggregatorSupport.getFullMonthLabel(request, year_month)
 
     def writeDownloadControls(self):
+
+        """
+        Return a representation of the download controls, featuring links for
+        view, calendar and customised downloads and subscriptions.
+        """
+
         page = self.page
         request = page.request
         fmt = page.formatter
@@ -274,6 +280,12 @@
         return "".join(output)
 
     def writeViewControls(self):
+
+        """
+        Return a representation of the view mode controls, permitting viewing of
+        aggregated events in calendar, list or table form.
+        """
+
         page = self.page
         request = page.request
         fmt = page.formatter
@@ -308,6 +320,12 @@
         return "".join(output)
 
     def writeMonthHeading(self, year_month):
+
+        """
+        Return the calendar heading for the given 'year_month' (a Month object)
+        providing links permitting navigation to other months.
+        """
+
         page = self.page
         request = page.request
         fmt = page.formatter
@@ -369,6 +387,12 @@
         return "".join(output)
 
     def writeDayNumberLinked(self, date):
+
+        """
+        Return a link for the given 'date' which will activate the new event
+        action for the given day.
+        """
+
         page = self.page
         request = page.request
         fmt = page.formatter