Slight docstring improvements

flexcompute · Sep 17, 2024 · 07aeda3 · 07aeda3
1 parent 297d336
commit 07aeda3
Showing 1 changed file with 3 additions and 15 deletions.
diff --git a/tidy3d/plugins/metrics/metrics.py b/tidy3d/plugins/metrics/metrics.py
@@ -27,24 +27,17 @@ class ModeCoefficient(Metric):
     """
     Metric for calculating the mode coefficient from a ModeMonitor.
 
-    Attributes
+    Parameters
     ----------
     monitor_name : str
         The name of the mode monitor.
     freqs : FreqArray
         The frequency array.
-    direction : Direction, default "+"
+    direction : Direction = "+"
         The direction of the mode.
-    mode_index : pd.NonNegativeInt, default 0
+    mode_index : pd.NonNegativeInt = 0
         The index of the mode.
 
-    Methods
-    -------
-    from_mode_monitor(monitor: ModeMonitor)
-        Creates a ModeCoefficient instance from a ModeMonitor.
-    evaluate(data: SimulationData) -> NumberType
-        Evaluates the mode coefficient from the simulation data.
-
     Examples
     --------
     >>> monitor = ModeMonitor(name="monitor1", freqs=[1.0])
@@ -80,11 +73,6 @@ class ModePower(ModeCoefficient):
     """
     Metric for calculating the mode power from a ModeMonitor.
 
-    Methods
-    -------
-    evaluate(data: SimulationData) -> NumberType
-        Evaluates the mode power from the simulation data.
-
     Examples
     --------
     >>> monitor = ModeMonitor(name="monitor1", freqs=[1.0])