change ioresp_plot to time_response_plot

murrayrm · murrayrm · commit 6bb8b56afefa · 2023-07-09T21:37:20.000-07:00
diff --git a/control/tests/kwargs_test.py b/control/tests/kwargs_test.py
@@ -186,7 +186,7 @@ def test_matplotlib_kwargs(function, nsysargs, moreargs, kwargs, mplcleanup):
     'gangof4_plot': test_matplotlib_kwargs,
     'input_output_response': test_unrecognized_kwargs,
     'interconnect': interconnect_test.test_interconnect_exceptions,
-    'ioresp_plot': timeplot_test.test_errors,
+    'time_response_plot': timeplot_test.test_errors,
     'linearize': test_unrecognized_kwargs,
     'lqe': test_unrecognized_kwargs,
     'lqr': test_unrecognized_kwargs,
diff --git a/control/tests/timeplot_test.py b/control/tests/timeplot_test.py
@@ -317,7 +317,7 @@ def test_errors():
         stepresp.plot(unknown=None)
 
     with pytest.raises(TypeError, match="unrecognized keyword"):
-        ct.ioresp_plot(stepresp, unknown=None)
+        ct.time_response_plot(stepresp, unknown=None)
 
     with pytest.raises(ValueError, match="unrecognized value"):
         stepresp.plot(plot_inputs='unknown')
diff --git a/control/timeplot.py b/control/timeplot.py
@@ -28,7 +28,7 @@
 
 from . import config
 
-__all__ = ['ioresp_plot', 'combine_traces']
+__all__ = ['time_response_plot', 'combine_traces']
 
 # Default font dictionary
 _timeplot_rcParams = mpl.rcParams.copy()
@@ -51,7 +51,7 @@
 }
 
 # Plot the input/output response of a system
-def ioresp_plot(
+def time_response_plot(
         data, ax=None, plot_inputs=None, plot_outputs=True, transpose=False,
         combine_traces=False, combine_signals=False, legend_map=None,
         legend_loc=None, add_initial_zero=True, title=None, relabel=True,
@@ -719,7 +719,7 @@ def get_axes(line_array):
     """Get a list of axes from an array of lines.
 
     This function can be used to return the set of axes corresponding to
-    the line array that is returned by `ioresp_plot`.  This is useful for
+    the line array that is returned by `time_response_plot`.  This is useful for
     generating an axes array that can be passed to subsequent plotting
     calls.
 
diff --git a/control/timeresp.py b/control/timeresp.py
@@ -81,7 +81,7 @@
 from . import config
 from .exception import pandas_check
 from .iosys import isctime, isdtime
-from .timeplot import ioresp_plot
+from .timeplot import time_response_plot
 
 
 __all__ = ['forced_response', 'step_response', 'step_info',
@@ -690,7 +690,7 @@ def to_pandas(self):
 
     # Plot data
     def plot(self, *args, **kwargs):
-        return ioresp_plot(self, *args, **kwargs)
+        return time_response_plot(self, *args, **kwargs)
 
 
 # Process signal labels
