Remove generic message for SlycotParameterError in docstring, synthes…

…is.py
python-control · Jan 6, 2024 · 54e6484 · 54e6484
1 parent 367bd71
commit 54e6484
Showing 1 changed file with 0 additions and 36 deletions.
diff --git a/slycot/synthesis.py b/slycot/synthesis.py
@@ -97,8 +97,6 @@ def sb01bd(n,m,np,alpha,A,B,w,dico,tol=0.0,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             the reduction of A to a real Schur form failed;
@@ -283,8 +281,6 @@ def sb02md(n,A,G,Q,dico,hinv='D',uplo='U',scal='N',sort='S',ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             Matrix A is (numerically) singular in discrete-
@@ -441,8 +437,6 @@ def sb02mt(n,m,B,R,A=None,Q=None,L=None,fact='N',jobl='Z',uplo='U',ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :1 <= info <= m:
             The {info}-th element of the `d` factor is
@@ -602,8 +596,6 @@ def sb02od(n,m,A,B,Q,R,dico,p=None,L=None,fact='N',uplo='U',sort='S',tol=0.0,ldw
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             The computed extended matrix pencil is singular,
@@ -764,11 +756,6 @@ def sb03md57(A, U=None, C=None,
     w : (n, ) complex ndarray
         If fact = 'N', this array contains the eigenvalues of A.
 
-    Raises
-    ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
-
     Warns
     -----
     SlycotResultWarning
@@ -927,8 +914,6 @@ def sb03od(n,m,A,Q,B,dico,fact='N',trans='N',ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 4:
             FACT = 'F' and the Schur factor S supplied in
@@ -1038,8 +1023,6 @@ def sb04md(n,m,A,B,C,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :0 < info <= m:
             The QR algorithm failed to compute all the eigenvalues
@@ -1089,8 +1072,6 @@ def sb04qd(n,m,A,B,C,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :0 < info <= m:
             The QR algorithm failed to compute all the eigenvalues
@@ -1237,8 +1218,6 @@ def sb10ad(n,m,np,ncon,nmeas,gamma,A,B,C,D,job=3,gtol=0.0,actol=0.0,liwork=None,
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             The matrix
@@ -1448,8 +1427,6 @@ def sb10dd(n,m,np,ncon,nmeas,gamma,A,B,C,D,tol=0.0,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             The matrix
@@ -1606,8 +1583,6 @@ def sb10hd(n,m,np,ncon,nmeas,A,B,C,D,tol=0.0,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             The matrix D12 had not full column rank in
@@ -1702,8 +1677,6 @@ def sb10jd(n,m,np,A,B,C,D,E,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info == 1:
             The iteration for computing singular value
@@ -1789,8 +1762,6 @@ def sb10yd(discfl,flag,lendat,rfrdat,ifrdat,omega,n,tol,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info == 0:  successful exit;
         :info < 0:   if info = -i, the i-th argument had an illegal value
@@ -2009,8 +1980,6 @@ def sg03ad(dico,job,fact,trans,uplo,N,A,E,Q,Z,X,ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             FACT = 'F' and the matrix contained in the upper
@@ -2345,8 +2314,6 @@ def sg02ad(dico,jobb,fact,uplo,jobl,scal,sort,acc,N,M,P,A,E,B,Q,R,L,ldwork=None,
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 1:
             The computed extended matrix pencil is singular,
@@ -2558,8 +2525,6 @@ def sg03bd(n,m,A,E,Q,Z,B,dico,fact='N',trans='N',ldwork=None):
 
     Raises
     ------
-    SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
     SlycotArithmeticError
         :info = 2:
             fact = 'F' and the matrix contained in the upper
@@ -2748,7 +2713,6 @@ def sb10fd(n,m,np,ncon,nmeas,gamma,A,B,C,D,tol=0.0,ldwork=None):
     Raises
     ------
     SlycotParameterError
-        :info = -i: the i-th argument had an illegal value;
         :info = -27:
             The dimension ldwork of the cache array is too small.
             Use ldwork=0 for the minimum size or ldwork=None for automatic