Write documentation for resource API module

src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_time.py

@@ -20,13 +20,45 @@ import ifcopenshell.util.date
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, resource=None):
+        """Adds the time that a resource is used for
+
+        For labour and equipment resources, the total duration that the resource
+        is used for may be stored. This may either be input manually or
+        calculated parametrically. This is known as the resource time, and may
+        be used to calculate other parameters like resource utilisation.
+
+        :param resource: The IfcConstructionResource to record time for.
+        :type resource: ifcopenshell.entity_instance.entity_instance
+        :return: The newly created IfcResourceTime
+        :rtype: ifcopenshell.entity_instance.entity_instance
+
+        Example::
+
+            # Add our own crew
+            crew = ifcopenshell.api.run("resource.add_resource", model, ifc_class="IfcCrewResource")
+
+            # Add some labour to our crew.
+            labour = ifcopenshell.api.run("resource.add_resource", model,
+                parent_resource=crew, ifc_class="IfcLaborResource")
+
+            # Labour resource is quantified in terms of time.
+            ifcopenshell.api.run("resource.add_resource_quantity", model,
+                resource=labour, ifc_class="IfcQuantityTime")
+
+            # Store the unit time used in hours
+            ifcopenshell.api.run("resource.edit_resource_quantity", model,
+                physical_quantity=time, attributes={"TimeValue": 8.0})
+
+            # Let's imagine we've used the resource for 2 days.
+            time = ifcopenshell.api.run("resource.add_resource_time", model, resource=labour)
+            ifcopenshell.api.run("resource.edit_resource_time", model,
+                resource_time=time, attributes={"ScheduleWork": "P16H"})
+        """
         self.file = file
         self.settings = {
-            "resource": None,
+            "resource": resource,
         }
-        for key, value in settings.items():
-            self.settings[key] = value
 
     def execute(self):
         resource_time = self.file.create_entity("IfcResourceTime")