Write documentation for sequence API module

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

@@ -20,11 +20,30 @@ import ifcopenshell.util.date
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, work_plan=None, attributes=None):
+        """Edits the attributes of an IfcWorkPlan
+
+        For more information about the attributes and data types of an
+        IfcWorkPlan, consult the IFC documentation.
+
+        :param work_plan: The IfcWorkPlan entity you want to edit
+        :type work_plan: ifcopenshell.entity_instance.entity_instance
+        :param attributes: a dictionary of attribute names and values.
+        :type attributes: dict, optional
+        :return: None
+        :rtype: None
+
+        Example::
+
+            # This will hold all our construction schedules
+            work_plan = ifcopenshell.api.run("sequence.add_work_plan", model, name="Construction")
+
+            # Let's give it a description
+            ifcopenshell.api.run("sequence.edit_work_plan", model,
+                work_plan=work_plan, attributes={"Description": "Construction of phase 1"})
+        """
         self.file = file
-        self.settings = {"work_plan": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"work_plan": work_plan, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():