rename to allow_nonproper

bnavigator · bnavigator · commit a0986c5488a7 · 2020-03-18T10:53:55.000+01:00
diff --git a/control/tests/xferfcn_test.py b/control/tests/xferfcn_test.py
@@ -561,9 +561,9 @@ def test_common_den_nonproper(self):
         np.testing.assert_raises(ValueError, tf1._common_den)
         np.testing.assert_raises(ValueError, tf2._common_den)
 
-        _, den1, _ = tf1._common_den(allownonproper=True)
+        _, den1, _ = tf1._common_den(allow_nonproper=True)
         np.testing.assert_array_almost_equal(den1, common_den_ref)
-        _, den2, _ = tf2._common_den(allownonproper=True)
+        _, den2, _ = tf2._common_den(allow_nonproper=True)
         np.testing.assert_array_almost_equal(den2, common_den_ref)
 
     @unittest.skipIf(not slycot_check(), "slycot not installed")
diff --git a/control/xferfcn.py b/control/xferfcn.py
@@ -679,7 +679,7 @@ def freqresp(self, omega):
 
     def pole(self):
         """Compute the poles of a transfer function."""
-        _, den, denorder = self._common_den(allownonproper=True)
+        _, den, denorder = self._common_den(allow_nonproper=True)
         rts = []
         for d, o in zip(den, denorder):
             rts.extend(roots(d[:o + 1]))
@@ -797,7 +797,7 @@ def returnScipySignalLTI(self):
 
         return out
 
-    def _common_den(self, imag_tol=None, allownonproper=False):
+    def _common_den(self, imag_tol=None, allow_nonproper=False):
         """
         Compute MIMO common denominators; return them and adjusted numerators.
 
@@ -813,7 +813,7 @@ def _common_den(self, imag_tol=None, allownonproper=False):
             Threshold for the imaginary part of a root to use in detecting
             complex poles
 
-        allownonproper : boolean
+        allow_nonproper : boolean
             Do not enforce proper transfer functions
 
         Returns
@@ -825,8 +825,8 @@ def _common_den(self, imag_tol=None, allownonproper=False):
             gives the numerator coefficient array for the ith output and jth
             input; padded for use in td04ad ('C' option); matches the
             denorder order; highest coefficient starts on the left.
-            If allownonproper=True and the order of a numerator exceeds the
-            order of the common denominator, num will be retured as None
+            If allow_nonproper=True and the order of a numerator exceeds the
+            order of the common denominator, num will be returned as None
 
         den: array
             sys.inputs by kd
@@ -942,7 +942,7 @@ def _common_den(self, imag_tol=None, allownonproper=False):
                     # numerater has a higher order than the denominator, the
                     # padding will fail
                     if len(numpoly) > maxindex + 1:
-                        if allownonproper:
+                        if allow_nonproper:
                             havenonproper = True
                             break
                         raise ValueError(
