addressed @slivingston review comments

murrayrm · murrayrm · commit 8f3701d77015 · 2025-02-02T19:50:30.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -14,7 +14,7 @@ record.txt
 .coverage
 doc/_build
 doc/generated
-examples/.ipynb_checkpoints/
+.ipynb_checkpoints/
 .settings/org.eclipse.core.resources.prefs
 .pydevproject
 .project
diff --git a/README.rst b/README.rst
@@ -31,7 +31,7 @@ Try out the examples in the examples folder using the binder service.
 
 The package can also be installed on Google Colab using the commands::
 
-  !pip install control
+  %pip install control
   import control as ct
 
 Features
@@ -49,11 +49,11 @@ Features
 Links
 -----
 
-- Project home page: http://python-control.org
+- Project home page: https://python-control.org
 - Source code repository: https://github.com/python-control/python-control
-- Documentation: http://python-control.readthedocs.org/
+- Documentation: https://python-control.readthedocs.io/
 - Issue tracker: https://github.com/python-control/python-control/issues
-- Mailing list: http://sourceforge.net/p/python-control/mailman/
+- Mailing list: https://sourceforge.net/p/python-control/mailman/
 
 Dependencies
 ------------
@@ -158,7 +158,7 @@ License
 -------
 
 This is free software released under the terms of `the BSD 3-Clause
-License <http://opensource.org/licenses/BSD-3-Clause>`_.  There is no
+License <https://opensource.org/licenses/BSD-3-Clause>`_.  There is no
 warranty; not even for merchantability or fitness for a particular
 purpose.  Consult LICENSE for copying conditions.
 
diff --git a/control/__init__.py b/control/__init__.py
@@ -9,7 +9,7 @@
 
 The initial goal for the package is to implement all of the
 functionality required to work through the examples in the textbook
-`Feedback Systems <http://fbsbook.org>`_ by Astrom and Murray.  In
+`Feedback Systems <https://fbsbook.org>`_ by Astrom and Murray.  In
 addition to standard techniques available for linear control systems,
 support for nonlinear systems (including trajectory generation, gain
 scheduling, phase plane diagrams, and describing functions) is
diff --git a/control/config.py b/control/config.py
@@ -272,7 +272,7 @@ def use_matlab_defaults():
 def use_fbs_defaults():
     """Use Feedback Systems (FBS) compatible settings.
 
-    The following conventions from `Feedback Systems <http://fbsbook.org>`_
+    The following conventions from `Feedback Systems <https://fbsbook.org>`_
     are used:
 
         * Bode plots plot gain in powers of ten, phase in degrees,
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -1033,7 +1033,7 @@ def gen_zero_centered_series(val_min, val_max, period):
     #
     # Because plots can be built up by multiple calls to plot(), the legend
     # strings are created from the line labels manually.  Thus an initial
-    # call to plot() may not generate any legends (eg, if no signals are
+    # call to plot() may not generate any legends (e.g., if no signals are
     # overlaid), but subsequent calls to plot() will need a legend for each
     # different response (system).
     #
diff --git a/control/modelsimp.py b/control/modelsimp.py
@@ -598,7 +598,7 @@ def markov(*args, m=None, transpose=False, dt=None, truncate=False):
     .. [1] J.-N. Juang, M. Phan, L. G.  Horta, and R. W. Longman,
        Identification of observer/Kalman filter Markov parameters - Theory
        and experiments. Journal of Guidance Control and Dynamics, 16(2),
-       320-329, 2012. http://doi.org/10.2514/3.21006
+       320-329, 2012. https://doi.org/10.2514/3.21006
 
     Examples
     --------
@@ -696,7 +696,7 @@ def markov(*args, m=None, transpose=False, dt=None, truncate=False):
     #   J.-N. Juang, M. Phan, L. G. Horta, and R. W. Longman, Identification
     #   of observer/Kalman filter Markov parameters - Theory and
     #   experiments. Journal of Guidance Control and Dynamics, 16(2),
-    #   320-329, 2012. http://doi.org/10.2514/3.21006
+    #   320-329, 2012. https://doi.org/10.2514/3.21006
     #
 
     # Set up the full problem
diff --git a/control/statefbk.py b/control/statefbk.py
@@ -559,7 +559,7 @@ def create_statefbk_iosystem(
         ctrl, clsys = ct.create_statefbk_iosystem(sys, K)
 
     where `sys` is the process dynamics and `K` is the state (+ integral)
-    feedback gain (eg, from LQR).  The function returns the controller
+    feedback gain (e.g., from LQR).  The function returns the controller
     `ctrl` and the closed loop systems `clsys`, both as I/O systems.
 
     A gain scheduled controller can also be created, by passing a list of
diff --git a/control/statesp.py b/control/statesp.py
@@ -1751,7 +1751,7 @@ def ss(*args, **kwargs):
                 warn("state labels specified for "
                      "non-unique state space realization")
 
-            # Allow method to be specified (eg, tf2ss)
+            # Allow method to be specified (e.g., tf2ss)
             method = kwargs.pop('method', None)
 
             # Create a state space system from an LTI system
diff --git a/control/timeplot.py b/control/timeplot.py
@@ -576,7 +576,7 @@ def _make_line_label(signal_index, signal_labels, trace_index):
     #
     # Because plots can be built up by multiple calls to plot(), the legend
     # strings are created from the line labels manually.  Thus an initial
-    # call to plot() may not generate any legends (eg, if no signals are
+    # call to plot() may not generate any legends (e.g., if no signals are
     # combined nor overlaid), but subsequent calls to plot() will need a
     # legend for each different line (system).
     #
diff --git a/control/timeresp.py b/control/timeresp.py
@@ -1963,7 +1963,7 @@ def impulse_response(
         #
         # We can't put the impulse into U because there is no numerical
         # representation for it (infinitesimally short, infinitely high).
-        # See also: http://www.mathworks.com/support/tech-notes/1900/1901.html
+        # See also: https://www.mathworks.com/support/tech-notes/1900/1901.html
         #
         if isctime(sys):
             X0 = sys.B[:, i]
diff --git a/doc/develop.rst b/doc/develop.rst
@@ -16,11 +16,11 @@ Package Structure
 The python-control package is maintained on GitHub, with documentation
 hosted by ReadTheDocs and a mailing list on SourceForge:
 
-  * Project home page: http://python-control.org
+  * Project home page: https://python-control.org
   * Source code repository: https://github.com/python-control/python-control
-  * Documentation: http://python-control.readthedocs.org/
+  * Documentation: https://python-control.readthedocs.io/
   * Issue tracker: https://github.com/python-control/python-control/issues
-  * Mailing list: http://sourceforge.net/p/python-control/mailman/
+  * Mailing list: https://sourceforge.net/p/python-control/mailman/
 
 GitHub repository file and directory layout:
   - **python-control/** - main repository
@@ -56,7 +56,7 @@ GitHub repository file and directory layout:
 
       + **matlab/** - MATLAB compatibility subpackage
 
-        - __init.py, timeresp.py, wrappers.py - subpackage files
+        - __init__.py, timeresp.py, wrappers.py - subpackage files
 
       + **tests/** - unit tests
 
@@ -222,7 +222,7 @@ frequency, etc:
         timepts, outputs, states=states, inputs=inputs)
 
   In the last command, note that states precedes inputs because not
-  all TimeResponseData elements have inputs (eg, `initial_response`).
+  all TimeResponseData elements have inputs (e.g., `initial_response`).
 
 * The default order for providing arguments in the frequency domain is
   system/response first, then frequency::
@@ -566,7 +566,7 @@ Sphinx files guidelines:
   - The Python built-ins occur frequently and are capitalized, and so
     the additional formatting doesn't add much and would be
     inconsistent if you jump from the User Guide to the Reference
-    Manual (eg, to look at a function more closely via a link in the
+    Manual (e.g., to look at a function more closely via a link in the
     User Guide).
 
 
diff --git a/doc/examples/template.py b/doc/examples/template.py
@@ -78,7 +78,7 @@ def __init__(self, sys):
         self.data = sys.name    # Attribute created within class
 
     def sample_method(self, data):
-        """Sample method within in a class.
+        """Sample method within a class.
 
         This is an example of a method within a class.  Document using
         numpydoc format.
@@ -92,10 +92,10 @@ def sample_function(data, option=False, **kwargs):
 
     This is an example of a public function within the template module.
     This function will usually be placed in the `control` namespace by
-    updating `__init.py` to import the function (often by importing the
+    updating `__init__.py` to import the function (often by importing the
     entire module).
 
-    Docstring should be in standard numpy doc format.  The extended summary
+    Docstring should be in standard numpydoc format.  The extended summary
     (this text) should describe the basic operation of the function, with
     technical details in the "Notes" section.
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -24,7 +24,7 @@ feedback control systems.
 
 - GitHub repository: https://github.com/python-control/python-control
 - Issue tracker: https://github.com/python-control/python-control/issues
-- Mailing list: http://sourceforge.net/p/python-control/mailman/
+- Mailing list: https://sourceforge.net/p/python-control/mailman/
 
 .. rubric:: How to cite
 
diff --git a/doc/intro.rst b/doc/intro.rst
@@ -115,7 +115,7 @@ Some Differences from MATLAB
 Users familiar with the MATLAB control systems toolbox will find much
 of the functionality implemented in `python-control`, though using
 Python constructs and coding conventions.  The python-control package
-makes heavy use of `NumPy <http://www.numpy.org>`_ and `SciPy
+makes heavy use of `NumPy <https://www.numpy.org>`_ and `SciPy
 <https://www.scipy.org>`_ and many differences are reflected in the
 use of those .  A list of general differences between NumPy and MATLAB
 can be found `here
diff --git a/doc/iosys.rst b/doc/iosys.rst
@@ -139,7 +139,7 @@ Illustrative example
 
 To illustrate the use of the :func:`interconnect` function, we create a
 model for a predator/prey system, following the notation and parameter
-values in `Feedback Systems <http://fbsbook.org>`_.
+values in `Feedback Systems <https://fbsbook.org>`_.
 
 We begin by defining the dynamics of the system:
 
@@ -219,7 +219,7 @@ system and computing the linearization about that point.
 We next compute a controller that stabilizes the equilibrium point using
 eigenvalue placement and computing the feedforward gain using the number of
 lynxes as the desired output (following `Feedback Systems
-<http://fbsbook.org>`_, Example 7.5):
+<https://fbsbook.org>`_, Example 7.5):
 
 .. testcode:: predprey
 
@@ -692,7 +692,7 @@ A reference gain controller can be created with the command::
       sys, K, kf, feedfwd_pattern='refgain')
 
 This reference gain design pattern is described in more detail in
-`Feedback Systems <http://fbsbook.org>`_, Section 7.2 (Stabilization
+`Feedback Systems <https://fbsbook.org>`_, Section 7.2 (Stabilization
 by State Feedback) and the trajectory generation design pattern is
 described in Section 8.5 (State Space Controller Design).
 
diff --git a/doc/releases/0.10.0-notes.rst b/doc/releases/0.10.0-notes.rst
@@ -146,7 +146,7 @@ generate a warning message when used:
 * `phase_plot`: Use `phase_plane_plot` instead.
 
 The listed items are slated to be removed in future releases (usually
-the next major or minor version update.
+the next major or minor version update).
 
 
 Removals
diff --git a/doc/releases/0.10.1-notes.rst b/doc/releases/0.10.1-notes.rst
@@ -197,4 +197,4 @@ generate a warning message when used:
 * Deprecated the `relabel` keyword in `time_response_plot`.
 
 The listed items are slated to be removed in future releases (usually
-the next major or minor version update.
+the next major or minor version update).
diff --git a/doc/releases/0.9.3-notes.rst b/doc/releases/0.9.3-notes.rst
@@ -126,4 +126,4 @@ generate a warning message when used:
   lb, ub)``.
 
 The listed items are slated to be removed in future releases (usually
-the next major or minor version update.
+the next major or minor version update).
diff --git a/doc/releases/0.9.4-notes.rst b/doc/releases/0.9.4-notes.rst
@@ -82,7 +82,7 @@ were implemented in this release:
   interconnection).
 
 * Added `control_indices` and `state_indices` to
-  `create_statefbk_iosystem` to allow partial interconnection (eg, for
+  `create_statefbk_iosystem` to allow partial interconnection (e.g., for
   inner/outer loop construction).
 
 * `create_mpc_iosystem` now allows system and signal names to be
@@ -115,7 +115,7 @@ generate a warning message when used:
 * `issys`: use ``isinstance(sys, ct.LTI)``.
 
 The listed items are slated to be removed in future releases (usually
-the next major or minor version update.
+the next major or minor version update).
 
 
 Removals
diff --git a/doc/releases/template.rst b/doc/releases/template.rst
@@ -60,7 +60,7 @@ generate a warning message when used:
 * Other calling patterns that will not be supported in the future.
 
 The listed items are slated to be removed in future releases (usually
-the next major or minor version update.
+the next major or minor version update).
 
 
 Removals
diff --git a/examples/.gitignore b/examples/.gitignore
@@ -1,2 +1 @@
 .ipynb-clean
-.ipynb_checkpoints/

Original file line number	Diff line number	Diff line change
`@@ -1033,7 +1033,7 @@ def gen_zero_centered_series(val_min, val_max, period):`
`1033`	`1033`	`#`
`1034`	`1034`	`# Because plots can be built up by multiple calls to plot(), the legend`
`1035`	`1035`	`# strings are created from the line labels manually. Thus an initial`
`1036`		`- # call to plot() may not generate any legends (eg, if no signals are`
	`1036`	`+ # call to plot() may not generate any legends (e.g., if no signals are`
`1037`	`1037`	`# overlaid), but subsequent calls to plot() will need a legend for each`
`1038`	`1038`	`# different response (system).`
`1039`	`1039`	`#`
Original file line number	Diff line number	Diff line change
`@@ -576,7 +576,7 @@ def _make_line_label(signal_index, signal_labels, trace_index):`
`576`	`576`	`#`
`577`	`577`	`# Because plots can be built up by multiple calls to plot(), the legend`
`578`	`578`	`# strings are created from the line labels manually. Thus an initial`
`579`		`- # call to plot() may not generate any legends (eg, if no signals are`
	`579`	`+ # call to plot() may not generate any legends (e.g., if no signals are`
`580`	`580`	`# combined nor overlaid), but subsequent calls to plot() will need a`
`581`	`581`	`# legend for each different line (system).`
`582`	`582`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1963,7 +1963,7 @@ def impulse_response(`
`1963`	`1963`	`#`
`1964`	`1964`	`# We can't put the impulse into U because there is no numerical`
`1965`	`1965`	`# representation for it (infinitesimally short, infinitely high).`
`1966`		`- # See also: http://www.mathworks.com/support/tech-notes/1900/1901.html`
	`1966`	`+ # See also: https://www.mathworks.com/support/tech-notes/1900/1901.html`
`1967`	`1967`	`#`
`1968`	`1968`	`if isctime(sys):`
`1969`	`1969`	`X0 = sys.B[:, i]`