address @slivingston review comments

murrayrm · murrayrm · commit fb2086c29f36 · 2024-08-12T22:26:22.000-07:00
diff --git a/control/ctrlplot.py b/control/ctrlplot.py
@@ -223,7 +223,7 @@ def get_plot_axes(line_array):
 
     .. deprecated:: 0.10.1
         This function will be removed in a future version of python-control.
-        Use `cplt.axes` to obtain axes for a control plot `cplt`.
+        Use `cplt.axes` to obtain axes for an instance of :class:`ControlPlot`.
 
     This function can be used to return the set of axes corresponding
     to the line array that is returned by `time_response_plot`.  This
@@ -276,7 +276,7 @@ def pole_zero_subplots(
         Figure to use for creating subplots.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set up config.default['freqplot.rcParams'].
+        Default is set up config.default['ctrlplot.rcParams'].
 
     Returns
     -------
diff --git a/control/dtime.py b/control/dtime.py
@@ -82,7 +82,7 @@ def sample_system(sysc, Ts, method='zoh', alpha=None, prewarp_frequency=None,
     Other Parameters
     ----------------
     inputs : int, list of str or None, optional
-        Description of the system inputs.  If not specified, the origional
+        Description of the system inputs.  If not specified, the original
         system inputs are used.  See :class:`InputOutputSystem` for more
         information.
     outputs : int, list of str or None, optional
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -171,8 +171,6 @@ def bode_plot(
     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 suppress legend.
-    magnitude_label : str, optional
-        Label to use for magnitude axis.  Defaults to "Magnitude".
     margins_method : str, optional
         Method to use in computing margins (see :func:`stability_margins`).
     omega_limits : array_like of two values
@@ -187,8 +185,6 @@ def bode_plot(
     overlay_inputs, overlay_outputs : bool, optional
         If set to True, combine input and/or output signals onto a single
         plot and use line colors, labels, and a legend to distinguish them.
-    phase_label : str, optional
-        Label to use for phase axis.  Defaults to "Phase [rad]".
     plot : bool, optional
         (legacy) If given, `bode_plot` returns the legacy return values
         of magnitude, phase, and frequency.  If False, just return the
@@ -211,8 +207,8 @@ def bode_plot(
         Set the title of the plot.  Defaults to plot type and system name(s).
     title_frame : str, optional
         Set the frame of reference used to center the plot title. If set to
-        'axes' (default), the horizontal position of the title will
-        centered relative to the axes.  If set to `figure`, it will be
+        'axes' (default), the horizontal position of the title will be
+        centered relative to the axes.  If set to 'figure', it will be
         centered with respect to the figure (faster execution).
     wrap_phase : bool or float
         If wrap_phase is `False` (default), then the phase will be unwrapped
@@ -1658,7 +1654,7 @@ def nyquist_plot(
     title_frame : str, optional
         Set the frame of reference used to center the plot title. If set to
         'axes' (default), the horizontal position of the title will
-        centered relative to the axes.  If set to `figure`, it will be
+        centered relative to the axes.  If set to 'figure', it will be
         centered with respect to the figure (faster execution).
     warn_nyquist : bool, optional
         If set to 'False', turn off warnings about frequencies above Nyquist.
@@ -2386,7 +2382,7 @@ def singular_values_plot(
         the values with no plot.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set up config.default['freqplot.rcParams'].
+        Default is set up config.default['ctrlplot.rcParams'].
     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
@@ -2396,7 +2392,7 @@ def singular_values_plot(
     title_frame : str, optional
         Set the frame of reference used to center the plot title. If set to
         'axes' (default), the horizontal position of the title will
-        centered relative to the axes.  If set to `figure`, it will be
+        centered relative to the axes.  If set to 'figure', it will be
         centered with respect to the figure (faster execution).
 
     See Also
diff --git a/control/iosys.py b/control/iosys.py
@@ -56,7 +56,7 @@ class InputOutputSystem(object):
         Description of the system inputs.  This can be given as an integer
         count or a list of strings that name the individual signals.  If an
         integer count is specified, the names of the signal will be of the
-        form `s[i]` (where `s` is given by the `input_prefix` parameter and
+        form 's[i]' (where 's' is given by the `input_prefix` parameter and
         has default value 'u').  If this parameter is not given or given as
         `None`, the relevant quantity will be determined when possible
         based on other information provided to functions using the system.
diff --git a/control/nlsys.py b/control/nlsys.py
@@ -66,7 +66,7 @@ class NonlinearIOSystem(InputOutputSystem):
         Description of the system inputs.  This can be given as an integer
         count or as a list of strings that name the individual signals.
         If an integer count is specified, the names of the signal will be
-        of the form `s[i]` (where `s` is one of `u`, `y`, or `x`).  If
+        of the form 's[i]' (where 's' is one of 'u', 'y', or 'x').  If
         this parameter is not given or given as `None`, the relevant
         quantity will be determined when possible based on other
         information provided to functions using the system.
@@ -1243,7 +1243,7 @@ def nlsys(
         Description of the system inputs.  This can be given as an integer
         count or as a list of strings that name the individual signals.
         If an integer count is specified, the names of the signal will be
-        of the form `s[i]` (where `s` is one of `u`, `y`, or `x`).  If
+        of the form 's[i]' (where 's' is one of 'u', 'y', or 'x').  If
         this parameter is not given or given as `None`, the relevant
         quantity will be determined when possible based on other
         information provided to functions using the system.
@@ -1969,7 +1969,7 @@ def linearize(sys, xeq, ueq=None, t=0, params=None, **kw):
     Other Parameters
     ----------------
     inputs : int, list of str or None, optional
-        Description of the system inputs.  If not specified, the origional
+        Description of the system inputs.  If not specified, the original
         system inputs are used.  See :class:`InputOutputSystem` for more
         information.
     outputs : int, list of str or None, optional
@@ -2101,7 +2101,7 @@ def interconnect(
         Description of the system inputs.  This can be given as an integer
         count or as a list of strings that name the individual signals.  If an
         integer count is specified, the names of the signal will be of the
-        form `s[i]` (where `s` is one of `u`, `y`, or `x`).  If this parameter
+        form 's[i]' (where 's' is one of 'u', 'y', or 'x').  If this parameter
         is not given or given as `None`, the relevant quantity will be
         determined when possible based on other information provided to
         functions using the system.
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -1014,7 +1014,7 @@ def phase_plot(odefun, X=None, Y=None, scale=1, X0=None, T=None,
     """(legacy) Phase plot for 2D dynamical systems.
 
     .. deprecated:: 0.10.1
-        This function is deprecated; use `phase_plane_plot` instead.
+        This function is deprecated; use :func:`phase_plane_plot` instead.
 
     Produces a vector field or stream line plot for a planar system.  This
     function has been replaced by the :func:`~control.phase_plane_map` and
diff --git a/control/statesp.py b/control/statesp.py
@@ -1919,15 +1919,12 @@ def rss(states=1, outputs=1, inputs=1, strictly_proper=False, **kwargs):
 
     Parameters
     ----------
-    states : int, list of str, or None
-        Description of the system states.  Same format as `inputs`.
-    outputs : int, list of str, or None
-        Description of the system outputs. This can be given as an integer
-        count or as a list of strings that name the individual signals.  If an
-        integer count is specified, the names of the signal will be of the
-        form `s[i]` (where `s` is one of `u`, `y`, or `x`).
-    inputs : int, list of str, or None
-        Description of the system inputs. Same format as `outputs`.
+    states, outputs, inputs : int, list of str, or None
+        Description of the system states, outputs, and inputs. This can be
+        given as an integer count or as a list of strings that name the
+        individual signals.  If an integer count is specified, the names of
+        the signal will be of the form 's[i]' (where 's' is one of 'x',
+        'y', or 'u').
     strictly_proper : bool, optional
         If set to 'True', returns a proper system (no direct term).
     dt : None, True or float, optional
diff --git a/control/tests/docstrings_test.py b/control/tests/docstrings_test.py
@@ -147,9 +147,10 @@ def test_parameter_docs(module, prefix):
                         continue
 
                     # Too complicated to check
-                    if f"*{argname}" not in docstring and verbose:
-                        print(f"      {name} has positional arguments; "
-                              "check manually")
+                    if f"*{argname}" not in docstring:
+                        if verbose:
+                            print(f"      {name} has positional arguments; "
+                                  "check manually")
                         warnings.warn(
                             f"{name} {argname} has positional arguments; "
                             "docstring not checked")
diff --git a/doc/plotting.rst b/doc/plotting.rst
@@ -654,11 +654,13 @@ Utility functions
 -----------------
 
 These additional functions can be used to manipulate response data or
-returned values from plotting routines.
+carry out other operations in creating control plots.
+
 
 .. autosummary::
    :toctree: generated/
 
+   ~control.box_grid
    ~control.combine_time_responses
    ~control.pole_zero_subplots
    ~control.reset_rcParams
