Enhance documentation

gso/products/__init__.py

@@ -147,6 +147,7 @@ class ProductType(strEnum):
     COMMERCIAL_PEER = CommercialPeer.__name__
     IMPORTED_COMMERCIAL_PEER = ImportedCommercialPeer.__name__
 
+
 SUBSCRIPTION_MODEL_REGISTRY.update(
     {
         ProductName.IP_TRUNK.value: Iptrunk,

gso/products/product_blocks/commercial_peer.py

@@ -53,7 +53,7 @@ class CommercialPeerBlockInactive(
 ):
     """A Commercial Peer that's not yet provisioned. See ``CommercialPeerBlock``."""
 
-    peering_connection: list[PeeringConnectionInactive]  # type: ignore[assignment]
+    peering_connection: list[PeeringConnectionInactive]
     prefix_limit: NonNegativeInt | None = None
 
 
@@ -65,7 +65,12 @@ class CommercialPeerBlockProvisioning(CommercialPeerBlockInactive, lifecycle=[Su
 
 
 class CommercialPeerBlock(CommercialPeerBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
-    """An Internet Exchange Port that's active."""
+    """An Internet Exchange Port that's active.
+
+    Attributes:
+        peering_connection: The Peering connection block
+        prefix_limit: The prefix limit
+    """
 
     peering_connection: list[PeeringConnection]  # type: ignore[assignment]
     prefix_limit: NonNegativeInt | None = None

gso/products/product_blocks/ix_port.py

@@ -16,7 +16,7 @@ class L3InterfacePortBlockInactive(
 ):
     """A Layer 3 Interface Port Block that's not yet provisioned. See ``L3InterfacePortBlock``."""
 
-    is_tagged: bool
+    is_tagged: bool | None = None
     vlan_id: VLAN_ID | None = None
     ipv4_address: IPv4AddressType | None = None
     ipv4_mask: IPv4Netmask | None = None
@@ -76,10 +76,14 @@ class IXPortBlockInactive(
 class IXPortBlockProvisioning(IXPortBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     """An IX Port that's being provisioned. See ``IXPortBlock``."""
 
-    l3_interface: L3InterfacePortBlockProvisioning
+    l3_interface: L3InterfacePortBlockProvisioning  # type: ignore[assignment]
 
 
 class IXPortBlock(IXPortBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
-    """An Internet Exchange Port that's active."""
+    """An Internet Exchange Port that's active.
+
+    Attributes:
+        l3_interface: The Layer 3 interface block associated with this IX port.
+    """
 
-    l3_interface: L3InterfacePortBlock
+    l3_interface: L3InterfacePortBlock  # type: ignore[assignment]

gso/products/product_blocks/private_peer_port.py

@@ -21,10 +21,14 @@ class PrivatePeerPortBlockInactive(
 class PrivatePeerPortBlockProvisioning(PrivatePeerPortBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     """An Private Peer Port that's being provisioned. See ``PrivatePeerPortBlock``."""
 
-    l3_interface: L3InterfacePortBlockProvisioning
+    l3_interface: L3InterfacePortBlockProvisioning  # type: ignore[assignment]
 
 
 class PrivatePeerPortBlock(PrivatePeerPortBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
-    """A Private Provider Port that's active."""
+    """A Private Provider Port that's active.
 
-    l3_interface: L3InterfacePortBlock
+    Attributes:
+        l3_interface: The Layer 3 interface block associated with this private peer port.
+    """
+
+    l3_interface: L3InterfacePortBlock  # type: ignore[assignment]

gso/products/product_blocks/transit_provider_port.py

@@ -23,10 +23,14 @@ class TransitProviderPortBlockProvisioning(
 ):
     """A Transit Provider Port that's being provisioned. See ``TransitProviderPortBlock``."""
 
-    l3_interface: L3InterfacePortBlockProvisioning
+    l3_interface: L3InterfacePortBlockProvisioning  # type: ignore[assignment]
 
 
 class TransitProviderPortBlock(TransitProviderPortBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
-    """A Transit Provider Port that's active."""
+    """A Transit Provider Port that's active.
 
-    l3_interface: L3InterfacePortBlock
+    Attributes:
+        l3_interface: The Layer 3 interface block associated with this transit provider port.
+    """
+
+    l3_interface: L3InterfacePortBlock  # type: ignore[assignment]