Add API documentation for document module

src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py

@@ -18,11 +18,32 @@
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, reference=None, attributes=None):
+        """Edits the attributes of an IfcDocumentReference
+
+        For more information about the attributes and data types of an
+        IfcDocumentReference, consult the IFC documentation.
+
+        :param reference: The IfcDocumentReference entity you want to edit
+        :type reference: ifcopenshell.entity_instance.entity_instance
+        :param attributes: a dictionary of attribute names and values.
+        :type attributes: dict, optional
+        :return: None
+        :rtype: None
+
+        Example::
+
+            document = ifcopenshell.api.run("document.add_information", model)
+            ifcopenshell.api.run("document.edit_information", model,
+                information=document,
+                attributes={"Identification": "A-GA-6100", "Name": "Overall Plan",
+                "Location": "A-GA-6100 - Overall Plan.pdf"})
+            reference = ifcopenshell.api.run("document.add_reference", model, information=document)
+            ifcopenshell.api.run("document.edit_reference", model,
+                reference=reference, attributes={"Identification": "2.1.15"})
+        """
         self.file = file
-        self.settings = {"reference": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"reference": reference, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():