Write docs for owner API module

src/ifcopenshell-python/ifcopenshell/api/owner/edit_address.py

@@ -18,11 +18,38 @@
 
 
 class Usecase:
-    def __init__(self, file, **settings):
+    def __init__(self, file, address=None, attributes=None):
+        """Edits the attributes of an IfcAddress
+
+        For more information about the attributes and data types of an
+        IfcAddress, consult the IFC documentation.
+
+        :param address: The IfcAddress entity you want to edit
+        :type address: ifcopenshell.entity_instance.entity_instance
+        :param attributes: a dictionary of attribute names and values.
+        :type attributes: dict, optional
+        :return: None
+        :rtype: None
+
+        Example::
+
+            # A snail mail address
+            postal = ifcopenshell.api.run("owner.add_address", model,
+                assigned_object=organisation, ifc_class="IfcPostalAddress")
+            ifcopenshell.api.run("owner.edit_address", model, address=postal,
+                attributes={"Purpose": "OFFICE", "AddressLines": ["42 Wallaby Way"],
+                "Town": "Sydney", "Region": "NSW", "PostalCode": "2000"})
+
+            # A phone or internet address
+            telecom = ifcopenshell.api.run("owner.add_address", model,
+                assigned_object=organisation, ifc_class="IfcTelecomAddress")
+            ifcopenshell.api.run("owner.edit_address", model, address=telecom,
+                attributes={"Purpose": "OFFICE", "TelephoneNumbers": ["+61432466949"],
+                "ElectronicMailAddresses": ["bobthebuilder@example.com"],
+                "WWWHomePageURL": "https://thinkmoult.com"})
+        """
         self.file = file
-        self.settings = {"address": None, "attributes": {}}
-        for key, value in settings.items():
-            self.settings[key] = value
+        self.settings = {"address": address, "attributes": attributes or {}}
 
     def execute(self):
         for name, value in self.settings["attributes"].items():