Add API docs for boundary module

src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py

@@ -18,16 +18,39 @@
 
 
 class Usecase:
-    def __init__(self, file, **kwargs):
-        """location, axis and ref_direction defines the plane"""
+    def __init__(self, file, entity=None, relating_space=None, related_building_element=None, parent_boundary=None, corresponding_boundary=None):
+        """Modify the relationships of a space boundary relationship
+
+        Currently this function is quite minimal and offers no advantage to
+        manual assignment of the space boundary attributes.
+
+        :param entity: The IfcRelSpaceBoundary to modify
+        :type entity: ifcopenshell.entity_instance.entity_instance
+        :param relating_space: The IfcSpace or IfcExternalSpatialElement that
+            the space boundary is related to.
+        :type relating_space: ifcopenshell.entity_instance.entity_instance
+        :param related_building_element: The IfcElement that defines the
+            boundary, typically an IfcWall.
+        :type relating_space: ifcopenshell.entity_instance.entity_instance
+        :param parent_boundary: A parent IfcRelSpaceBoundary, only provided if
+            this is an inner boundary. This can apply to 1st and 2nd level
+            boundaries.
+        :type parent_boundary: ifcopenshell.entity_instance.entity_instance,
+            optional
+        :param corresponding_boundary: The other IfcRelSpaceBoundary on the
+            other side of the related element. The pair together represents a
+            thermal boundary. This only applies to 2nd level boundaries.
+        :type corresponding_boundary: ifcopenshell.entity_instance.entity_instance,
+            optional
+        :return: None
+        :rtype: None
+        """
         self.file = file
-        self.entity: "IfcRelSpaceBoundary"
-        self.relating_space: "IfcSpace | IfcExternalSpatialElement"
-        self.related_building_element: "IfcElement"
-        self.parent_boundary: "IfcRelSpaceBoundary" = None
-        self.corresponding_boundary: "IfcRelSpaceBoundary" = None
-        for key, value in kwargs.items():
-            setattr(self, key, value)
+        self.entity = entity
+        self.relating_space = relating_space
+        self.related_building_element = related_building_element
+        self.parent_boundary = parent_boundary
+        self.corresponding_boundary = corresponding_boundary
 
     def execute(self):
         self.entity.RelatingSpace = self.relating_space