Add documentation for cost module

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py

@@ -22,11 +22,31 @@ import ifcopenshell.util.element
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, cost_value=None, attributes=None):
+        """Edits the attributes of an IfcCostValue
+
+        For more information about the attributes and data types of an
+        IfcCostValue, consult the IFC documentation.
+
+        :param cost_value: The IfcCostValue entity you want to edit
+        :type cost_value: ifcopenshell.entity_instance.entity_instance
+        :param attributes: a dictionary of attribute names and values.
+        :type attributes: dict, optional
+        :return: None
+        :rtype: None
+
+        Example::
+
+            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
+            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)
+
+            # This cost item will have a total cost of 42
+            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
+            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
+                attributes={"AppliedValue": 42.0})
+        """
         self.file = file
-        self.settings = {"cost_value": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"cost_value": cost_value, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():