BUG: indent_radius not handled properly when passed to nyquist_plot

murrayrm · murrayrm · commit eeebec326035 · 2024-06-26T08:50:50.000-07:00
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -1536,9 +1536,6 @@ def nyquist_plot(
     color : string, optional
         Used to specify the color of the line and arrowhead.
 
-    return_contour : bool, optional
-        If 'True', return the contour used to evaluate the Nyquist plot.
-
     **kwargs : :func:`matplotlib.pyplot.plot` keyword properties, optional
         Additional keywords (passed to `matplotlib`)
 
@@ -1630,6 +1627,10 @@ def nyquist_plot(
         max_curve_magnitude).  Default linestyle (['-', '-.']) is
         determined by config.defaults['nyquist.mirror_style'].
 
+    return_contour : bool, optional
+        (legacy) If 'True', return the encirclement count and Nyquist
+        contour used to generate the Nyquist plot.
+
     start_marker : str, optional
         Matplotlib marker to use to mark the starting point of the Nyquist
         plot.  Defaults value is 'o' and can be set using
@@ -1760,6 +1761,7 @@ def _parse_linestyle(style_name, allow_false=False):
             omega_num=kwargs.pop('omega_num', None),
             warn_encirclements=kwargs.pop('warn_encirclements', True),
             warn_nyquist=kwargs.pop('warn_nyquist', True),
+            indent_radius=kwargs.pop('indent_radius', None),
             check_kwargs=False, **kwargs)
     else:
         nyquist_responses = data
diff --git a/control/tests/nyquist_test.py b/control/tests/nyquist_test.py
@@ -300,6 +300,15 @@ def test_nyquist_indent_do(indentsys):
     np.testing.assert_allclose(contour[:50].real**2 + contour[:50].imag**2,
                                0.01**2)
 
+    # Make sure that the command also works if called directly as _plot()
+    plt.figure()
+    with pytest.warns(DeprecationWarning, match=".* use nyquist_response()"):
+        count, contour = ct.nyquist_plot(
+            indentsys, indent_radius=0.01, return_contour=True)
+    assert _Z(indentsys) == count + _P(indentsys)
+    np.testing.assert_allclose(
+        contour[:50].real**2 + contour[:50].imag**2, 0.01**2)
+
 
 def test_nyquist_indent_left(indentsys):
     plt.figure();
