# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1462968270 -7200
# Node ID 6470334f8449ed52270f5a0bbedae8d82ccf1e67
# Parent  2121da71f66d2930a668cccf281be5fe98df426c
Added details of the mutable parameter to free/busy collections.

diff -r 2121da71f66d -r 6470334f8449 imiptools/period.py
--- a/imiptools/period.py	Wed May 11 12:53:42 2016 +0200
+++ b/imiptools/period.py	Wed May 11 14:04:30 2016 +0200
@@ -357,7 +357,8 @@
 
     "A free/busy record abstraction."
 
-    def __init__(self, start, end, uid=None, transp=None, recurrenceid=None, summary=None, organiser=None, expires=None):
+    def __init__(self, start, end, uid=None, transp=None, recurrenceid=None,
+        summary=None, organiser=None, expires=None):
 
         """
         Initialise a free/busy period with the given 'start' and 'end' points,
@@ -655,7 +656,8 @@
 
         """
         Initialise the collection with the given list of 'periods', or start an
-        empty collection if no list is given.
+        empty collection if no list is given. If 'mutable' is indicated, the
+        collection may be changed; otherwise, an exception will be raised.
         """
 
         FreeBusyCollectionBase.__init__(self, mutable)
@@ -858,12 +860,14 @@
 
     period_columns = ["start", "end", "object_uid", "transp", "object_recurrenceid", "summary", "organiser", "expires"]
 
-    def __init__(self, cursor, table_name, column_names=None, filter_values=None, mutable=True, paramstyle=None):
+    def __init__(self, cursor, table_name, column_names=None, filter_values=None,
+        mutable=True, paramstyle=None):
 
         """
         Initialise the collection with the given 'cursor' and with the
         'table_name', 'column_names' and 'filter_values' configuring the
-        selection of data.
+        selection of data. If 'mutable' is indicated, the collection may be
+        changed; otherwise, an exception will be raised.
         """
 
         FreeBusyCollectionBase.__init__(self, mutable)