Add documentation comment

Author: stevekeay

python/ironic-understack/ironic_understack/update_baremetal_port.py

@@ -43,6 +43,10 @@ def __call__(self, task, inventory, plugin_data):
         with an ipv4_address address and has_carrier set to True.  This is our
         pxe boot interface.  We should clear the pxe interface flag on all other
         baremetal ports.
+
+        The interface MAC gets passed to us in plugin_data["boot_interface"] if
+        the node was inspected by booting the IPA image.  Not sure what would be
+        set by redfish here.
         """
         LOG.debug(f"{__class__} called with {task=!r} {inventory=!r} {plugin_data=!r}")
 

python/ironic-understack/ironic_understack/vlan_group_name_convention.py

@@ -16,6 +16,11 @@ def vlan_group_name(switch_name: str, mapping: dict[str, str]) -> str:
 
     >>> vlan_group_name("a123-20-1", {"1": "network"})
     >>> "a123-20-network"
+
+    VLAN Groups are currentlty REQUIRED to span a single cabinet.  A VLAN Group
+    that spans multiple cabinets would be named like "a123-20/21-network" but we
+    can't support this because we have no way to determine which switches are
+    paired together.
     """
     switch_name = switch_name.split(".")[0].lower()