update to address 29 Dec comments by @slivingston

murrayrm · murrayrm · commit e10d4814d8b8 · 2024-12-29T14:15:13.000-08:00
diff --git a/control/frdata.py b/control/frdata.py
@@ -81,7 +81,7 @@ class constructor, using the :func:`~control.frd` factory function, or
     frequency : 1D array
         Array of frequency points for which data are available.
     ninputs, noutputs : int
-        Number of inputs and outputs signals.
+        Number of input and output signals.
     shape : tuple
         2-tuple of I/O system dimension, (noutputs, ninputs).
     input_labels, output_labels : array of str
@@ -93,7 +93,7 @@ class constructor, using the :func:`~control.frd` factory function, or
     magnitude : array
         Magnitude of the frequency response, indexed by frequency.
     phase : array
-        Magnitude of the frequency response, indexed by frequency.
+        Phase of the frequency response, indexed by frequency.
 
     Other Parameters
     ----------------
diff --git a/control/statesp.py b/control/statesp.py
@@ -1,8 +1,9 @@
 # statesp.py - state space class and related functions
 #
-# Author: Richard M. Murray
-# Date: 24 May 09
-# Revised: Kevin K. Chen, Dec 10
+# Original author: Richard M. Murray
+# Creation date: 24 May 2009
+# Pre-2014 revisions: Kevin K. Chen, Dec 10
+# Use `git shortlog -n -s statesp.py` for full list of contributors
 
 """State space representation and functions.
 
diff --git a/control/tests/docstrings_test.py b/control/tests/docstrings_test.py
@@ -284,7 +284,7 @@ def test_deprecated_functions(module, prefix):
 #
 # List of arguments described in class docstrings
 #
-# These are the minimal arguments needed to initialized the class.  Optional
+# These are the minimal arguments needed to initialize the class.  Optional
 # arguments should be documented in the factory functions and do not need
 # to be duplicated in the class documentation.
 #
@@ -301,7 +301,7 @@ def test_deprecated_functions(module, prefix):
 # List of attributes described in class docstrings
 #
 # This is the list of attributes for the class that are not already listed
-# as parameters used to inialize the class.  These should all be defined
+# as parameters used to initialize the class.  These should all be defined
 # in the class docstring.
 #
 # Attributes that are part of all I/O system classes should be listed in
diff --git a/control/xferfcn.py b/control/xferfcn.py
@@ -1,8 +1,9 @@
 # xferfcn.py - transfer function class and related functions
 #
-# Author: Richard M. Murray
-# Date: 24 May 09
-# Revised: Kevin K. Chen, Dec 2010
+# Original author: Richard M. Murray
+# Creation date: 24 May 2009
+# Pre-2014 revisions: Kevin K. Chen, Dec 2010
+# Use `git shortlog -n -s xferfcn.py` for full list of contributors
 
 """Transfer function representation and functions.
 
@@ -91,7 +92,7 @@ class TransferFunction(LTI):
 
     Notes
     -----
-    The numerator and denominator polynomials are stored as 2D ndarray's
+    The numerator and denominator polynomials are stored as 2D ndarrays
     with each element containing a 1D ndarray of coefficients.  These data
     structures can be retrieved using ``num_array`` and ``den_array``.  For
     example,
@@ -1399,9 +1400,9 @@ def _tf_factorized_polynomial_to_string(roots, gain=1, var='s'):
 
 
 def _tf_string_to_latex(thestr, var='s'):
-    """Superscript all digits in a polynomial string and convert float
-        coefficients in scientific notation to prettier LaTeX
-        representation.
+    """Superscript all digits in a polynomial string and convert
+    float coefficients in scientific notation to prettier LaTeX
+    representation.
 
     """
     # TODO: make the multiplication sign configurable

Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ def test_deprecated_functions(module, prefix):`
`284`	`284`	`#`
`285`	`285`	`# List of arguments described in class docstrings`
`286`	`286`	`#`
`287`		`-# These are the minimal arguments needed to initialized the class. Optional`
	`287`	`+# These are the minimal arguments needed to initialize the class. Optional`
`288`	`288`	`# arguments should be documented in the factory functions and do not need`
`289`	`289`	`# to be duplicated in the class documentation.`
`290`	`290`	`#`
`@@ -301,7 +301,7 @@ def test_deprecated_functions(module, prefix):`
`301`	`301`	`# List of attributes described in class docstrings`
`302`	`302`	`#`
`303`	`303`	`# This is the list of attributes for the class that are not already listed`
`304`		`-# as parameters used to inialize the class. These should all be defined`
	`304`	`+# as parameters used to initialize the class. These should all be defined`
`305`	`305`	`# in the class docstring.`
`306`	`306`	`#`
`307`	`307`	`# Attributes that are part of all I/O system classes should be listed in`