Write documentation for sequence API module

src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py

@@ -18,11 +18,38 @@
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, recurrence_pattern=None, attributes=None):
+        """Edits the attributes of an IfcRecurrencePattern
+
+        For more information about the attributes and data types of an
+        IfcRecurrencePattern, consult the IFC documentation.
+
+        :param recurrence_pattern: The IfcRecurrencePattern entity you want to edit
+        :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance
+        :param attributes: a dictionary of attribute names and values.
+        :type attributes: dict, optional
+        :return: None
+        :rtype: None
+
+        Example::
+
+            # Let's create a new calendar.
+            calendar = ifcopenshell.api.run("sequence.add_work_calendar", model)
+
+            # Let's start defining the times that we work during the week.
+            work_time = ifcopenshell.api.run("sequence.add_work_time", model,
+                work_calendar=calendar, time_type="WorkingTimes")
+
+            # We create a weekly recurrence
+            pattern = ifcopenshell.api.run("sequence.assign_recurrence_pattern", model,
+                parent=work_time, recurrence_type="WEEKLY")
+
+            # State that we work from weekdays 1 to 5 (i.e. Monday to Friday)
+            ifcopenshell.api.run("sequence.edit_recurrence_pattern", model,
+                recurrence_pattern=pattern, attributes={"WeekdayComponent": [1, 2, 3, 4, 5]})
+        """
         self.file = file
-        self.settings = {"recurrence_pattern": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"recurrence_pattern": recurrence_pattern, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():