fix: config.default[] to config.defaults[]

murrayrm · murrayrm · commit bbfcfa3d9619 · 2025-02-02T20:40:10.000-08:00
diff --git a/control/flatsys/bezier.py b/control/flatsys/bezier.py
@@ -1,7 +1,7 @@
 # bezier.m - 1D Bezier curve basis functions
 # RMM, 24 Feb 2021
 
-"""1D Bezier curve basis functions.
+r"""1D Bezier curve basis functions.
 
 The :mod:`control.flatsys.bezier` module defines the
 :class:`BezierFamily` class, which implements a set of basis functions
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -196,7 +196,7 @@ def bode_plot(
         If set to `False`, don't plot the magnitude or phase, respectively.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     share_frequency, share_magnitude, share_phase : str or bool, optional
         Determine whether and how axis limits are shared between the
         indicated variables.  Can be set set to 'row' to share across all
@@ -1663,7 +1663,7 @@ def nyquist_plot(
         determined by config.defaults['nyquist.mirror_style'].
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     return_contour : bool, optional
         (legacy) If 'True', return the encirclement count and Nyquist
         contour used to generate the Nyquist plot.
@@ -2413,7 +2413,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['ctrlplot.rcParams'].
+        Default is set up config.defaults['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
diff --git a/control/nichols.py b/control/nichols.py
@@ -81,7 +81,7 @@ def nichols_plot(
         with no legend for a single response.  Use False to suppress legend.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['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 the
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -149,7 +149,7 @@ def phase_plane_plot(
         in the dict as keywords to :func:`~control.phaseplot.separatrices`.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     suppress_warnings : bool, optional
         If set to `True`, suppress warning messages in generating trajectories.
     title : str, optional
@@ -290,7 +290,7 @@ def vectorfield(
     ----------------
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     suppress_warnings : bool, optional
         If set to `True`, suppress warning messages in generating trajectories.
 
@@ -400,7 +400,7 @@ def streamlines(
         value can be set in config.defaults['phaseplot.arrow_style'].
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     suppress_warnings : bool, optional
         If set to `True`, suppress warning messages in generating trajectories.
 
@@ -512,7 +512,7 @@ def equilpoints(
     ----------------
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
 
     """
     # Process keywords
@@ -604,7 +604,7 @@ def separatrices(
     ----------------
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     suppress_warnings : bool, optional
         If set to `True`, suppress warning messages in generating trajectories.
 
diff --git a/control/pzmap.py b/control/pzmap.py
@@ -199,7 +199,7 @@ def pole_zero_plot(
         If `True` plot omega-damping grid, if `False` show imaginary axis
         for continuous time systems, unit circle for discrete time systems.
         If `empty`, do not draw any additonal lines.  Default value is set
-        by config.default['pzmap.grid'] or config.default['rlocus.grid'].
+        by config.defaults['pzmap.grid'] or config.defaults['rlocus.grid'].
     plot : bool, optional
         (legacy) If ``True`` a graph is generated with Matplotlib,
         otherwise the poles and zeros are only computed and returned.
@@ -259,7 +259,7 @@ def pole_zero_plot(
         Set the line width of the markers used for poles and zeros.
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     scaling : str or list, optional
         Set the type of axis scaling.  Can be 'equal' (default), 'auto', or
         a list of the form [xmin, xmax, ymin, ymax].
diff --git a/control/rlocus.py b/control/rlocus.py
@@ -119,7 +119,7 @@ def root_locus_plot(
         If `True` plot omega-damping grid, if `False` show imaginary axis
         for continuous time systems, unit circle for discrete time systems.
         If `empty`, do not draw any additonal lines.  Default value is set
-        by config.default['rlocus.grid'].
+        by config.defaults['rlocus.grid'].
     initial_gain : float, optional
         Mark the point on the root locus diagram corresponding to the
         given gain.
diff --git a/control/timeplot.py b/control/timeplot.py
@@ -138,7 +138,7 @@ def time_response_plot(
         default values are set by config.defaults['timeplot.output_props'].
     rcParams : dict
         Override the default parameters used for generating plots.
-        Default is set by config.default['ctrlplot.rcParams'].
+        Default is set by config.defaults['ctrlplot.rcParams'].
     relabel : bool, optional
         (deprecated) By default, existing figures and axes are relabeled
         when new data are added.  If set to `False`, just plot new data on
diff --git a/doc/config.rst b/doc/config.rst
@@ -31,6 +31,12 @@ parameters based on standard configurations:
    use_matlab_defaults
    use_legacy_defaults
 
+.. Set the current module to be control.config.defaults so that each of
+   the parameters gets a link of the form control.config.defaults.<param>.
+   This can be linked from the documentation using a the construct
+   `config.defaults['param'] <control.config.defaults.param>`.
+
+.. currentmodule:: control.config.defaults
 
 System creation parameters
 --------------------------
@@ -329,8 +335,8 @@ Plotting parameters
 
     If wrap_phase is `False`, then the phase will be unwrapped so that it
     is continuously increasing or decreasing.  If wrap_phase is `True` the
-    phase will be restricted to the range [-180, 180) (or [:math:`-\\pi`,
-    :math:`\\pi`) radians). If `wrap_phase` is specified as a float, the
+    phase will be restricted to the range [-180, 180) (or [:math:`-\pi`,
+    :math:`\pi`) radians). If `wrap_phase` is specified as a float, the
     phase will be offset by 360 degrees if it falls below the specified
     value.
 
