update sphinxdocs and docstrings to fix missing function refs

murrayrm · murrayrm · commit d6058076c818 · 2025-02-02T20:39:20.000-08:00
diff --git a/control/optimal.py b/control/optimal.py
@@ -1953,13 +1953,18 @@ def __init__(
         self.outputs = response.outputs
 
 
-# Compute the moving horizon estimate for a nonlinear system
+# Compute the finite horizon estimate for a nonlinear system
 def solve_oep(
         sys, timepts, Y, U, trajectory_cost, X0=None,
         trajectory_constraints=None, initial_guess=None,
         squeeze=None, print_summary=True, **kwargs):
 
-    """Compute the solution to a moving horizon estimation problem.
+    """Compute the solution to a finite horizon estimation problem.
+
+    This function computes the maximum likelihood estimate of a system
+    state given the input and output over a fixed horizon.  The likelihood
+    is evaluated according to a cost function whose value is minimized
+    to compute the maximum likelhood estimate.
 
     Parameters
     ----------
diff --git a/control/statesp.py b/control/statesp.py
@@ -1929,6 +1929,9 @@ def ssdata(sys):
 def linfnorm(sys, tol=1e-10):
     """L-infinity norm of a linear system.
 
+    .. deprecated:: 0.10.2
+        This functionality is now available in :func:`sysnorm`.
+
     Parameters
     ----------
     sys : LTI (StateSpace or TransferFunction)
@@ -1952,6 +1955,7 @@ def linfnorm(sys, tol=1e-10):
     --------
     slycot.ab13dd : the Slycot routine linfnorm that does the calculation
     """
+    warn("linfnorm() is deprecated; use sysnorm(sys, p='inf')", FutureWarning)
 
     if ab13dd is None:
         raise ControlSlycot("Can't find slycot module 'ab13dd'")
diff --git a/control/tests/statesp_test.py b/control/tests/statesp_test.py
@@ -19,11 +19,11 @@
 from control.config import defaults
 from control.dtime import sample_system
 from control.lti import evalfr
-from control.statesp import (StateSpace, _convert_to_statespace, _rss_generate,
-                             _statesp_defaults, drss, linfnorm, rss, ss, tf2ss)
-from control.tests.conftest import (assert_tf_close_coeff, editsdefaults,
-                                    slycotonly)
+from control.statesp import StateSpace, _convert_to_statespace, tf2ss, \
+    _statesp_defaults, _rss_generate, linfnorm, ss, rss, drss
 from control.xferfcn import TransferFunction, ss2tf
+from control.tests.conftest import assert_tf_close_coeff, editsdefaults, \
+    slycotonly
 
 
 class TestStateSpace:
@@ -1515,13 +1515,15 @@ def dt_siso(self, request):
         return ct.c2d(systype(*sysargs), dt), refgpeak, reffpeak
 
     @slycotonly
+    @pytest.mark.usefixtures('ignore_future_warning')
     def test_linfnorm_ct_siso(self, ct_siso):
         sys, refgpeak, reffpeak = ct_siso
         gpeak, fpeak = linfnorm(sys)
         np.testing.assert_allclose(gpeak, refgpeak)
         np.testing.assert_allclose(fpeak, reffpeak)
 
     @slycotonly
+    @pytest.mark.usefixtures('ignore_future_warning')
     def test_linfnorm_dt_siso(self, dt_siso):
         sys, refgpeak, reffpeak = dt_siso
         gpeak, fpeak = linfnorm(sys)
@@ -1530,6 +1532,7 @@ def test_linfnorm_dt_siso(self, dt_siso):
         np.testing.assert_allclose(fpeak, reffpeak)
 
     @slycotonly
+    @pytest.mark.usefixtures('ignore_future_warning')
     def test_linfnorm_ct_mimo(self, ct_siso):
         siso, refgpeak, reffpeak = ct_siso
         sys = ct.append(siso, siso)
diff --git a/doc/control.rst b/doc/control.rst
@@ -30,12 +30,14 @@ System interconnections
    :toctree: generated/
 
     append
+    combine_tf
     connect
     feedback
     interconnect
     negate
     parallel
     series
+    split_tf
     connection_table
     combine_tf
     split_tf
@@ -81,13 +83,15 @@ Control system analysis
 .. autosummary::
    :toctree: generated/
 
+    bandwidth
     dcgain
     describing_function
     frequency_response
     get_input_ff_index
     get_output_fb_index
     ispassive
     margin
+    solve_passivity_LMI
     stability_margins
     step_info
     phase_crossover_frequencies
diff --git a/doc/optimal.rst b/doc/optimal.rst
@@ -492,5 +492,6 @@ The following classes and functions are defined in the
    ~control.optimal.output_range_constraint
    ~control.optimal.quadratic_cost
    ~control.optimal.solve_ocp
+   ~control.optimal.solve_oep
    ~control.optimal.state_poly_constraint
    ~control.optimal.state_range_constraint
diff --git a/doc/plotting.rst b/doc/plotting.rst
@@ -673,7 +673,9 @@ Plotting functions
    ~control.nichols_plot
    ~control.nyquist_plot
    ~control.phase_plane_plot
+   phaseplot.circlegrid
    phaseplot.equilpoints
+   phaseplot.meshgrid
    phaseplot.separatrices
    phaseplot.streamlines
    phaseplot.vectorfield
