add standalone docstrings_test mode + fix docstrings

murrayrm · murrayrm · commit f2285e484745 · 2025-02-02T20:06:43.000-08:00
diff --git a/control/flatsys/flatsys.py b/control/flatsys/flatsys.py
@@ -235,7 +235,7 @@ def flatsys(*args, updfcn=None, outfcn=None, **kwargs):
 
     Returns
     -------
-    sys: :class:`FlatSystem`
+    sys : :class:`FlatSystem`
         Flat system.
 
     Other Parameters
diff --git a/control/lti.py b/control/lti.py
@@ -277,7 +277,7 @@ def zeros(sys):
 
     Returns
     -------
-    zeros: ndarray
+    zeros : ndarray
         Array that contains the system's zeros.
 
     See Also
diff --git a/control/nichols.py b/control/nichols.py
@@ -208,14 +208,14 @@ def nichols_grid(cl_mags=None, cl_phases=None, line_style='dotted', ax=None,
 
     Returns
     -------
-    cl_mag_lines: list of `matplotlib.line.Line2D`
+    cl_mag_lines : list of `matplotlib.line.Line2D`
       The constant closed-loop gain contours
-    cl_phase_lines: list of `matplotlib.line.Line2D`
+    cl_phase_lines : list of `matplotlib.line.Line2D`
       The constant closed-loop phase contours
-    cl_mag_labels: list of `matplotlib.text.Text`
+    cl_mag_labels : list of `matplotlib.text.Text`
       mcontour labels; each entry corresponds to the respective entry
       in ``cl_mag_lines``
-    cl_phase_labels: list of `matplotlib.text.Text`
+    cl_phase_labels : list of `matplotlib.text.Text`
       ncontour labels; each entry corresponds to the respective entry
       in ``cl_phase_lines``
     """
diff --git a/control/nlsys.py b/control/nlsys.py
@@ -1191,11 +1191,11 @@ def check_unused_signals(
 
         Returns
         -------
-        dropped_inputs: list of tuples
+        dropped_inputs : list of tuples
             A list of the dropped input signals, with each element of the
             list in the form of (isys, isig).
 
-        dropped_outputs: list of tuples
+        dropped_outputs : list of tuples
             A list of the dropped output signals, with each element of the
             list in the form of (osys, osig).
 
diff --git a/control/optimal.py b/control/optimal.py
@@ -785,7 +785,7 @@ def compute_trajectory(
         -------
         res : OptimalControlResult
             Bundle object with the results of the optimal control problem.
-        res.success: bool
+        res.success : bool
             Boolean flag indicating whether the optimization was successful.
         res.time : array
             Time values of the input.
@@ -830,7 +830,7 @@ def compute_mpc(self, x, squeeze=None):
 
         Parameters
         ----------
-        x: array-like or number, optional
+        x : array-like or number, optional
             Initial state for the system.
         squeeze : bool, optional
             If True and if the system has a single output, return the system
@@ -1706,7 +1706,7 @@ def compute_estimate(
             Estimated disturbance inputs for the system trajectory.
         res.states : array
             Time evolution of the estimated state vector.
-        res.outputs: array
+        res.outputs : array
             Estimated measurement noise for the system trajectory.
 
         """
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -747,7 +747,7 @@ def meshgrid(xvals, yvals):
 
     Returns
     -------
-    grid: 2D array
+    grid : 2D array
         Array of points with shape (n * m, 2) defining the mesh
 
     """
@@ -777,7 +777,7 @@ def circlegrid(centers, radius, num):
 
     Returns
     -------
-    grid: 2D array
+    grid : 2D array
         Array of points with shape (p * num, 2) defining the circles.
 
     """
diff --git a/control/pzmap.py b/control/pzmap.py
@@ -225,7 +225,7 @@ def pole_zero_plot(
 
         See :class:`ControlPlot` for more detailed information.
 
-    poles, zeros: list of arrays
+    poles, zeros : list of arrays
         (legacy) If the `plot` keyword is given, the system poles and zeros
         are returned.
 
diff --git a/control/robust.py b/control/robust.py
@@ -396,7 +396,7 @@ def mixsyn(g, w1=None, w2=None, w3=None):
 
         then cl is the system from w->z with `u = -k*y`.
 
-    info: tuple
+    info : tuple
         gamma: scalar
             H-infinity norm of cl.
         rcond: array
diff --git a/control/tests/docstrings_test.py b/control/tests/docstrings_test.py
