update MATLAB function list

murrayrm · murrayrm · commit a6b30b1697e4 · 2025-02-02T21:00:15.000-08:00
diff --git a/control/nichols.py b/control/nichols.py
@@ -177,9 +177,9 @@ def _inner_extents(ax):
 
 def nichols_grid(cl_mags=None, cl_phases=None, line_style='dotted', ax=None,
                  label_cl_phases=True):
-    """Nichols chart grid.
+    """Plot Nichols chart grid.
 
-    Plots a Nichols chart grid on the current axis, or creates a new chart
+    Plots a Nichols chart grid on the current axes, or creates a new chart
     if no plot already exists.
 
     Parameters
diff --git a/doc/matlab.rst b/doc/matlab.rst
@@ -67,6 +67,7 @@ Time-Domain Analysis
    impulse
    initial
    lsim
+   stepinfo
 
 Frequency-Domain Analysis
 =========================
@@ -75,8 +76,9 @@ Frequency-Domain Analysis
 
    bode
    nyquist
-   nichols
    margin
+   nichols
+   ngrid
    freqresp
    evalfr
 
diff --git a/doc/test_sphinxdocs.py b/doc/test_sphinxdocs.py
@@ -62,10 +62,9 @@
 standalone = False
 
 control_module_list = [
-    control, control.flatsys, control.optimal, control.phaseplot
-]
+    control, control.flatsys, control.optimal, control.phaseplot]
 @pytest.mark.parametrize("module", control_module_list)
-def test_sphinx_functions(module):
+def test_sphinx_functions(module, check_legacy=True):
 
     # Look through every object in the package
     _info(f"Checking module {module}", 1)
@@ -104,7 +103,8 @@ def test_sphinx_functions(module):
                 case True, _, True, _:
                     _warn(f"deprecated object" + referenced)
                 case True, _, _, True:
-                    _warn(f"legacy object" + referenced)
+                    if check_legacy:
+                        _warn(f"legacy object" + referenced)
                 case False, False, False, False:
                     _fail(f"{objname} not referenced in sphinx docs")
 
@@ -160,6 +160,12 @@ def test_config_defaults():
         _warn(f"Unknown params in config.rst: {config_rstdocs}")
 
 
+# Test MATLAB library separately (and after config_defaults)
+def test_sphinx_matlab():
+    import control.matlab
+    test_sphinx_functions(control.matlab, check_legacy=False)
+
+
 def _check_deprecated(obj):
     with warnings.catch_warnings():
         warnings.simplefilter('ignore')     # debug via sphinx, not here
@@ -193,5 +199,6 @@ def _fail(str, level=-1):
 
     for module in control_module_list:
         test_sphinx_functions(module)
-
     test_config_defaults()
+    test_sphinx_matlab()
+
