deprecate relabel keyword in time_response_plot

murrayrm · murrayrm · commit fc09a856488e · 2024-08-08T14:54:49.000-07:00
diff --git a/control/tests/timeplot_test.py b/control/tests/timeplot_test.py
@@ -530,8 +530,9 @@ def test_relabel():
     ct.step_response(sys1).plot()
 
     # Generate a new plt, without relabeling
-    cplt = ct.step_response(sys2).plot(relabel=False)
-    assert cplt.axes[0, 0].get_ylabel() == 'y'
+    with pytest.warns(FutureWarning, match="deprecated"):
+        cplt = ct.step_response(sys2).plot(relabel=False)
+        assert cplt.axes[0, 0].get_ylabel() == 'y'
 
 
 def test_errors():
diff --git a/control/timeplot.py b/control/timeplot.py
@@ -131,8 +131,9 @@ def time_response_plot(
         List of line properties to use when plotting combined outputs.  The
         default values are set by config.defaults['timeplot.output_props'].
     relabel : bool, optional
-        By default, existing figures and axes are relabeled when new data
-        are added.  If set to `False`, just plot new data on existing axes.
+        [deprecated] By default, existing figures and axes are relabeled
+        when new data are added.  If set to `False`, just plot new data on
+        existing axes.
     show_legend : bool, optional
         Force legend to be shown if ``True`` or hidden if ``False``.  If
         ``None``, then show legend when there is more than one line on an
@@ -456,6 +457,7 @@ def _make_line_label(signal_index, signal_labels, trace_index):
 
     # Stop here if the user wants to control everything
     if not relabel:
+        warn("relabel keyword is deprecated", FutureWarning)
         return ControlPlot(out, ax_array, fig)
 
     #
