# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1438288226 -7200
# Node ID 1a6c35d7fddefed9e984686df1f137675c073c1f
# Parent  b567a5b9a816e5389bdc04cae3cc0d49d873f925
Added docstrings about period types.

diff -r b567a5b9a816 -r 1a6c35d7fdde imipweb/data.py
--- a/imipweb/data.py	Thu Jul 30 22:11:56 2015 +0200
+++ b/imipweb/data.py	Thu Jul 30 22:30:26 2015 +0200
@@ -273,6 +273,13 @@
             return {"VALUE" : "DATE"}
 
 def event_period_from_period(period):
+
+    """
+    Convert a 'period' to one suitable for use in an iCalendar representation.
+    In an "event period" representation, the end day of any date-level event is
+    encoded as the "day after" the last day actually involved in the event.
+    """
+
     if isinstance(period, EventPeriod):
         return period
     elif isinstance(period, FormPeriod):
@@ -285,6 +292,13 @@
         return EventPeriod(dtstart, dtend, period.tzid, period.origin, dtstart_attr, dtend_attr)
 
 def form_period_from_period(period):
+
+    """
+    Convert a 'period' into a representation usable in a user-editable form.
+    In a "form period" representation, the end day of any date-level event is
+    presented in a "natural" form, not the iCalendar "day after" form.
+    """
+
     if isinstance(period, EventPeriod):
         return period.as_form_period()
     elif isinstance(period, FormPeriod):