change check_kwargs to _check_kwargs and disable docstring check

murrayrm · murrayrm · commit b767e52565d6 · 2024-08-11T14:18:00.000-07:00
diff --git a/control/descfcn.py b/control/descfcn.py
@@ -271,7 +271,7 @@ def __len__(self):
 # Compute the describing function response + intersections
 def describing_function_response(
         H, F, A, omega=None, refine=True, warn_nyquist=None,
-        plot=False, check_kwargs=True, **kwargs):
+        plot=False, _check_kwargs=True, **kwargs):
     """Compute the describing function response of a system.
 
     This function uses describing function analysis to analyze a closed
@@ -328,7 +328,7 @@ def describing_function_response(
     # Start by drawing a Nyquist curve
     response = nyquist_response(
         H, omega, warn_encirclements=warn_nyquist, warn_nyquist=warn_nyquist,
-        check_kwargs=check_kwargs, **kwargs)
+        _check_kwargs=_check_kwargs, **kwargs)
     H_omega, H_vals = response.contour.imag, H(response.contour)
 
     # Compute the describing function
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -1145,7 +1145,7 @@ def plot(self, *args, **kwargs):
 def nyquist_response(
         sysdata, omega=None, plot=None, omega_limits=None, omega_num=None,
         return_contour=False, warn_encirclements=True, warn_nyquist=True,
-        check_kwargs=True, **kwargs):
+        _check_kwargs=True, **kwargs):
     """Nyquist response for a system.
 
     Computes a Nyquist contour for the system over a (optional) frequency
@@ -1260,7 +1260,7 @@ def nyquist_response(
     indent_points = config._get_param(
         'nyquist', 'indent_points', kwargs, _nyquist_defaults, pop=True)
 
-    if check_kwargs and kwargs:
+    if _check_kwargs and kwargs:
         raise TypeError("unrecognized keywords: ", str(kwargs))
 
     # Convert the first argument to a list
@@ -1769,7 +1769,7 @@ def _parse_linestyle(style_name, allow_false=False):
             warn_encirclements=kwargs.pop('warn_encirclements', True),
             warn_nyquist=kwargs.pop('warn_nyquist', True),
             indent_radius=kwargs.pop('indent_radius', None),
-            check_kwargs=False, **kwargs)
+            _check_kwargs=False, **kwargs)
     else:
         nyquist_responses = data
 
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -172,7 +172,7 @@ def _create_kwargs(global_kwargs, local_kwargs, **other_kwargs):
             kwargs, plot_streamlines, gridspec=gridspec, gridtype=gridtype,
             ax=ax)
         out[0] += streamlines(
-            sys, pointdata, timedata, check_kwargs=False,
+            sys, pointdata, timedata, _check_kwargs=False,
             suppress_warnings=suppress_warnings, **kwargs_local)
 
         # Get rid of keyword arguments handled by streamlines
@@ -188,7 +188,7 @@ def _create_kwargs(global_kwargs, local_kwargs, **other_kwargs):
         kwargs_local = _create_kwargs(
             kwargs, plot_separatrices, gridspec=gridspec, ax=ax)
         out[0] += separatrices(
-            sys, pointdata, check_kwargs=False, **kwargs_local)
+            sys, pointdata, _check_kwargs=False, **kwargs_local)
 
         # Get rid of keyword arguments handled by separatrices
         for kw in ['arrows', 'arrow_size', 'arrow_style', 'params']:
@@ -198,7 +198,7 @@ def _create_kwargs(global_kwargs, local_kwargs, **other_kwargs):
         kwargs_local = _create_kwargs(
             kwargs, plot_vectorfield, gridspec=gridspec, ax=ax)
         out[1] = vectorfield(
-            sys, pointdata, check_kwargs=False, **kwargs_local)
+            sys, pointdata, _check_kwargs=False, **kwargs_local)
 
         # Get rid of keyword arguments handled by vectorfield
         for kw in ['color', 'params']:
@@ -208,7 +208,7 @@ def _create_kwargs(global_kwargs, local_kwargs, **other_kwargs):
         kwargs_local = _create_kwargs(
             kwargs, plot_equilpoints, gridspec=gridspec, ax=ax)
         out[2] = equilpoints(
-            sys, pointdata, check_kwargs=False, **kwargs_local)
+            sys, pointdata, _check_kwargs=False, **kwargs_local)
 
         # Get rid of keyword arguments handled by equilpoints
         for kw in ['params']:
@@ -231,7 +231,7 @@ def _create_kwargs(global_kwargs, local_kwargs, **other_kwargs):
 
 def vectorfield(
         sys, pointdata, gridspec=None, ax=None, suppress_warnings=False,
-        check_kwargs=True, **kwargs):
+        _check_kwargs=True, **kwargs):
     """Plot a vector field in the phase plane.
 
     This function plots a vector field for a two-dimensional state
@@ -301,7 +301,7 @@ def vectorfield(
     color = _get_color(kwargs, ax=ax)
 
     # Make sure all keyword arguments were processed
-    if check_kwargs and kwargs:
+    if _check_kwargs and kwargs:
         raise TypeError("unrecognized keywords: ", str(kwargs))
 
     # Generate phase plane (quiver) data
@@ -321,7 +321,7 @@ def vectorfield(
 
 def streamlines(
         sys, pointdata, timedata=1, gridspec=None, gridtype=None, dir=None,
-        ax=None, check_kwargs=True, suppress_warnings=False, **kwargs):
+        ax=None, _check_kwargs=True, suppress_warnings=False, **kwargs):
     """Plot stream lines in the phase plane.
 
     This function plots stream lines for a two-dimensional state space
@@ -399,7 +399,7 @@ def streamlines(
     color = _get_color(kwargs, ax=ax)
 
     # Make sure all keyword arguments were processed
-    if check_kwargs and kwargs:
+    if _check_kwargs and kwargs:
         raise TypeError("unrecognized keywords: ", str(kwargs))
 
     # Create reverse time system, if needed
@@ -433,7 +433,7 @@ def streamlines(
 
 
 def equilpoints(
-        sys, pointdata, gridspec=None, color='k', ax=None, check_kwargs=True,
+        sys, pointdata, gridspec=None, color='k', ax=None, _check_kwargs=True,
         **kwargs):
     """Plot equilibrium points in the phase plane.
 
@@ -496,7 +496,7 @@ def equilpoints(
     points, _ = _make_points(pointdata, gridspec, 'meshgrid')
 
     # Make sure all keyword arguments were processed
-    if check_kwargs and kwargs:
+    if _check_kwargs and kwargs:
         raise TypeError("unrecognized keywords: ", str(kwargs))
 
     # Search for equilibrium points
@@ -513,7 +513,7 @@ def equilpoints(
 
 def separatrices(
         sys, pointdata, timedata=None, gridspec=None, ax=None,
-        check_kwargs=True, suppress_warnings=False, **kwargs):
+        _check_kwargs=True, suppress_warnings=False, **kwargs):
     """Plot separatrices in the phase plane.
 
     This function plots separatrices for a two-dimensional state space
@@ -606,7 +606,7 @@ def separatrices(
             stable_color = unstable_color = color
 
     # Make sure all keyword arguments were processed
-    if check_kwargs and kwargs:
+    if _check_kwargs and kwargs:
         raise TypeError("unrecognized keywords: ", str(kwargs))
 
     # Create a "reverse time" system to use for simulation
diff --git a/control/tests/docstrings_test.py b/control/tests/docstrings_test.py
@@ -58,7 +58,7 @@ def test_docstrings(module, prefix):
 
             # Go through each parameter and make sure it is in the docstring
             for argname, par in sig.parameters.items():
-                if argname == 'self':
+                if argname == 'self' or argname[0] == '_':
                     continue
                 
                 if par.kind == inspect.Parameter.VAR_KEYWORD:
