address review comments from @slivingston

murrayrm · murrayrm · commit cd8fcfdb294d · 2024-08-08T14:54:49.000-07:00
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -167,7 +167,7 @@ def bode_plot(
         string (see :func:`~matplotlib.pyplot.legend`).
     legend_loc : int or str, optional
         Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        with no legend for a single response.  Use False to suppress legend.
     margins_method : str, optional
         Method to use in computing margins (see :func:`stability_margins`).
     omega_limits : array_like of two values
@@ -1582,8 +1582,8 @@ def nyquist_plot(
         Label every nth frequency on the plot.  If not specified, no labels
         are generated.
     legend_loc : int or str, optional
-        Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        Include a legend in the given location. Default is 'upper right',
+        with no legend for a single response.  Use False to suppress legend.
     max_curve_magnitude : float, optional
         Restrict the maximum magnitude of the Nyquist plot to this value.
         Portions of the Nyquist plot whose magnitude is restricted are
@@ -2137,7 +2137,7 @@ def gangof4_response(
 def gangof4_plot(
         *args, omega=None, omega_limits=None, omega_num=None,
         Hz=False, **kwargs):
-    """Plot the response of the "Gange of 4" transfer functions for a system.
+    """Plot the response of the "Gang of 4" transfer functions for a system.
 
     Plots a 2x2 frequency response for the "Gang of 4" sensitivity
     functions [T, PS; CS, S].  Can be called in one of two ways:
@@ -2168,9 +2168,20 @@ def gangof4_plot(
 
     Returns
     -------
-    response : :class:`~control.FrequencyResponseData`
-        Frequency response with inputs 'r' and 'd' and outputs 'y', and 'u'
-        representing the 2x2 matrix of transfer functions in the Gang of 4.
+    cplt : :class:`ControlPlot` object
+        Object containing the data that were plotted:
+
+          * cplt.lines: 2x2 array of :class:`matplotlib.lines.Line2D`
+            objects for each line in the plot.  The value of each array
+            entry is a list of Line2D objects in that subplot.
+
+          * cplt.axes: 2D array of :class:`matplotlib.axes.Axes` for the plot.
+
+          * cplt.figure: :class:`matplotlib.figure.Figure` containing the plot.
+
+          * cplt.legend: legend object(s) contained in the plot
+
+        See :class:`ControlPlot` for more detailed information.
 
     """
     if len(args) == 1 and isinstance(arg, FrequencyResponseData):
@@ -2332,7 +2343,7 @@ def singular_values_plot(
         system.
     legend_loc : int or str, optional
         Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        with no legend for a single response.  Use False to suppress legend.
     omega_limits : array_like of two values
         Set limits for plotted frequency range. If Hz=True the limits are
         in Hz otherwise in rad/s.  Specifying ``omega`` as a list of two
diff --git a/control/nichols.py b/control/nichols.py
@@ -87,7 +87,7 @@ def nichols_plot(
         system.
     legend_loc : int or str, optional
         Include a legend in the given location. Default is 'upper left',
-        with no legend for a single response.  Use False to supress legend.
+        with no legend for a single response.  Use False to suppress legend.
     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 the
diff --git a/control/pzmap.py b/control/pzmap.py
@@ -243,8 +243,8 @@ def pole_zero_plot(
         label(s).  If data is a list, strings should be specified for each
         system.
     legend_loc : int or str, optional
-        Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        Include a legend in the given location. Default is 'upper right',
+        with no legend for a single response.  Use False to suppress legend.
     marker_color : str, optional
         Set the color of the markers used for poles and zeros.
     marker_size : int, optional
@@ -273,10 +273,10 @@ def pole_zero_plot(
        use matplotlib.pyplot.gca().axis('auto') and then set the axis
        limits to the desired values.
 
-    2. Pole/zero plts that use the continuous time omega-damping grid do
+    2. Pole/zero plots that use the continuous time omega-damping grid do
        not work with the ``ax`` keyword argument, due to the way that axes
        grids are implemented.  The ``grid`` argument must be set to
-       ``False`` or `'empty'`` when using the ``ax`` keyword argument.
+       ``False`` or ``'empty'`` when using the ``ax`` keyword argument.
 
     """
     # Get parameter values
diff --git a/control/rlocus.py b/control/rlocus.py
@@ -171,7 +171,7 @@ def root_locus_plot(
         system.
     legend_loc : int or str, optional
         Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        with no legend for a single response.  Use False to suppress legend.
     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 the
diff --git a/control/timeplot.py b/control/timeplot.py
@@ -122,7 +122,7 @@ def time_response_plot(
         string (see :func:`~matplotlib.pyplot.legend`).
     legend_loc : int or str, optional
         Include a legend in the given location. Default is 'center right',
-        with no legend for a single response.  Use False to supress legend.
+        with no legend for a single response.  Use False to suppress legend.
     output_props : array of dicts, optional
         List of line properties to use when plotting combined outputs.  The
         default values are set by config.defaults['timeplot.output_props'].
diff --git a/control/timeresp.py b/control/timeresp.py
@@ -111,7 +111,7 @@ class TimeResponseData:
     :attr:`time`, :attr:`outputs`, :attr:`states`, :attr:`inputs`.  When
     accessing time responses via their properties, squeeze processing is
     applied so that (by default) single-input, single-output systems will have
-    the output and input indices supressed.  This behavior is set using the
+    the output and input indices suppressed.  This behavior is set using the
     ``squeeze`` keyword.
 
     Attributes
diff --git a/doc/plotting.rst b/doc/plotting.rst
@@ -456,7 +456,7 @@ various ways.  The following general rules apply:
 
   The :func:`~control.bode_plot`, :func:`~control.time_response_plot`,
   and selected other commands can also accept a matplotlib format
-  string (e.g., 'r--').  The format string must appear as a positional
+  string (e.g., ``'r--'``).  The format string must appear as a positional
   argument right after the required data argument.
 
   Note that line property arguments are the same for all lines generated as
@@ -482,8 +482,8 @@ various ways.  The following general rules apply:
   locus plots), the default labels are the system name.
 
   If ``label`` is set to ``False``, individual lines are still given
-  labels, but no legend is generated in the plot (this can also be
-  accomplished by setting ``legend_map`` to ``False``.
+  labels, but no legend is generated in the plot. (This can also be
+  accomplished by setting ``legend_map`` to ``False``).
 
   Note: the ``label`` keyword argument is not implemented for describing
   function plots or phase plane plots, since these plots are primarily
@@ -501,7 +501,7 @@ various ways.  The following general rules apply:
   the ``legend_loc`` keyword argument is set to a string or integer, it
   will set the position of the legend as described in the
   :func:`matplotlib.legend` documentation.  Finally, ``legend_map`` can be
-  set to an` array that matches the shape of the subplots, with each item
+  set to an array that matches the shape of the subplots, with each item
   being a string indicating the location of the legend for that axes (or
   ``None`` for no legend).
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,7 +40,7 @@ dynamic = ["version"]
 packages = ["control"]
 
 [project.optional-dependencies]
-test = ["pytest", "pytest-timeout"]
+test = ["pytest", "pytest-timeout", "ruff"]
 slycot = [ "slycot>=0.4.0" ]
 cvxopt = [ "cvxopt>=1.2.0" ]
 
