Feature/update docstrings

Quality of life improvements for the documentation, better ignore rules for vale, and all code documentation now is adapted to the new style

gso/products/product_blocks/edge_port.py

@@ -12,16 +12,14 @@ from gso.utils.types.interfaces import LAGMemberList, PhysicalPortCapacity
 
 
 class EncapsulationType(strEnum):
-    """Types of encapsulation for edge ports.
-
-    Null supports a single service on the port.
-    Dot1Q supports multiple services for one customer or services for multiple customers.
-    QinQ expands VLAN space by double-tagging frames.
-    """
+    """Types of encapsulation for edge ports."""
 
     DOT1Q = "dot1q"
+    """Dot1Q supports multiple services for one customer or services for multiple customers."""
     QINQ = "qinq"
+    """QinQ expands VLAN space by double-tagging frames."""
     NULL = "null"
+    """Null supports a single service on the port."""
 
 
 class EdgePortType(strEnum):
@@ -94,29 +92,32 @@ class EdgePortBlockProvisioning(EdgePortBlockInactive, lifecycle=[SubscriptionLi
 
 
 class EdgePortBlock(EdgePortBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
-    """An edge port that's currently deployed in the network."""
+    """An edge port that's currently deployed in the network.
+
+    Attributes:
+        node: The router that this Edge Port is connected to.
+        edge_port_name: The name of the edge port, in our case, corresponds to the name of the LAG interface.
+        edge_port_description: A description of the edge port.
+        enable_lacp: Indicates whether LACP is enabled for this edge port.
+        encapsulation: The type of encapsulation used on this edge port, by default DOT1Q.
+        mac_address: The MAC address assigned to this edge port, if applicable.
+        member_speed: The speed capacity of each member in the physical port.
+        minimum_links: The minimum number of links required for this edge port.
+        edge_port_type: The type of edge port (e.g., customer, private, public).
+        ignore_if_down: If set to True, the edge port will be ignored if it is down.
+        ga_id: The GEANT GA ID associated with this edge port, if any.
+        edge_port_ae_members: A list of LAG members associated with this edge port.
+    """
 
-    #: The router that this edge port is connected to.
     node: RouterBlock
-    #: The name of the edge port, in our case, corresponds to the name of the LAG interface.
     edge_port_name: str
-    #: A description of the edge port.
     edge_port_description: str | None = None
-    #: Indicates whether LACP is enabled for this edge port.
     enable_lacp: bool
-    #: The type of encapsulation used on this edge port, by default DOT1Q.
     encapsulation: EncapsulationType = EncapsulationType.DOT1Q
-    #: The MAC address assigned to this edge port, if applicable.
     mac_address: str | None = None
-    #: The speed capacity of each member in the physical port.
     member_speed: PhysicalPortCapacity
-    #: The minimum number of links required for this edge port.
     minimum_links: int | None = None
-    #: The type of edge port (e.g., customer, private, public).
     edge_port_type: EdgePortType
-    #: If set to True, the edge port will be ignored if it is down.
     ignore_if_down: bool = False
-    #: The GEANT GA ID associated with this edge port, if any.
     ga_id: str | None = None
-    #: A list of LAG members associated with this edge port.
     edge_port_ae_members: LAGMemberList[EdgePortAEMemberBlock]  # type: ignore[assignment]