Write documentation for sequence API module

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

@@ -21,11 +21,45 @@ import ifcopenshell.api
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, rel_sequence=None, attributes=None):
+        """Edits the attributes of an IfcRelSequence
+
+        For more information about the attributes and data types of an
+        IfcRelSequence, consult the IFC documentation.
+
+        :param rel_sequence: The IfcRelSequence entity you want to edit
+        :type rel_sequence: 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 imagine we are creating a construction schedule. All tasks
+            # need to be part of a work schedule.
+            schedule = ifcopenshell.api.run("sequence.add_work_schedule", model, name="Construction Schedule A")
+
+            # Let's imagine a root construction task
+            construction = ifcopenshell.api.run("sequence.add_task", model,
+                work_schedule=schedule, name="Construction", identification="C")
+
+            # Let's imagine we're building 2 zones, one after another.
+            zone1 = ifcopenshell.api.run("sequence.add_task", model,
+                parent_task=construction, name="Zone 1", identification="C.1")
+            zone2 = ifcopenshell.api.run("sequence.add_task", model,
+                parent_task=construction, name="Zone 2", identification="C.2")
+
+            # Zone 1 finishes, then zone 2 starts.
+            sequence = ifcopenshell.api.run("sequence.assign_sequence", model,
+                relating_process=zone1, related_process=zone2)
+
+            # What if they both started at the same time?
+            ifcopenshell.api.run("sequence.edit_sequence", model,
+                rel_sequence=sequence, attributes={"SequenceType": "START_START"})
+        """
         self.file = file
-        self.settings = {"rel_sequence": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"rel_sequence": rel_sequence, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():