Further docstring classes

Author: daquinteroflex

tidy3d/plugins/smatrix/data/data.py

@@ -21,30 +21,56 @@
 
 
 class MicrowavePortSimulationData(Tidy3dBaseModel):
-    data: dict[str, SimulationData]
+    """Stores raw simulation data from each microwave port-specific simulation."""
+
+    data: dict[str, SimulationData] = pd.Field(
+        ...,
+        title="Port Simulation Data",
+        description="A dictionary mapping each port name to its corresponding raw SimulationData object. "
+        "This contains the raw field and mode data from the individual simulations "
+        "run for each port to compute the S-parameters.",
+    )
 
 
 class MicrowaveSMatrixData(Tidy3dBaseModel):
-    port_reference_impedances: Optional[PortDataArray]
-    data: TerminalPortDataArray
+    """Stores the computed S-matrix and reference impedances for the terminal ports."""
+
+    port_reference_impedances: Optional[PortDataArray] = pd.Field(
+        None,
+        title="Port Reference Impedances",
+        description="Reference impedance for each port used in the S-parameter calculation. "
+        "This is optional and may not be present if not specified or computed.",
+    )
+    data: TerminalPortDataArray = pd.Field(
+        ...,
+        title="S-Matrix Data",
+        description="An array containing the computed S-matrix of the device. The data is organized "
+        "by terminal ports, representing the scattering parameters between them.",
+    )
 
 
 class TerminalComponentModelerData(Tidy3dBaseModel):
     """
-    This class does not inherit from AbstractSimulationData intentionally, but does require some similar fields.
+    Data associated with a :class:`TerminalComponentModeler` simulation run.
+
+    This class serves as a data container for the results of a component modeler simulation,
+    holding the original simulation definition, the resulting S-matrix or raw port data,
+    and the solver log.
     """
 
     simulation: TerminalComponentModeler = pd.Field(
         ...,
         title="TerminalComponentModeler",
-        description="Original :class:`TerminalComponentModeler` associated with the data.",
+        description="The original :class:`TerminalComponentModeler` object that defines the simulation setup "
+        "and from which this data was generated.",
     )
 
     data: Union[MicrowaveSMatrixData, MicrowavePortSimulationData] = pd.Field(
         ...,
-        title="MicrowaveSMatrixData",
-        description="List of :class:`AbstractMonitorData` instances "
-        "associated with the monitors of the original :class:`AbstractSimulation`.",
+        title="Microwave Data",
+        description="The primary data output of the simulation. This can either be the computed "
+        ":class:`MicrowaveSMatrixData` containing the final S-parameters, or the "
+        "raw :class:`MicrowavePortSimulationData` if the S-matrix computation was not performed.",
     )
 
     log: str = pd.Field(