Skip to content

Commit a3336a4

Browse files
committed
unify docstring for return ScipySignalLTI
1 parent 41e12be commit a3336a4

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

control/statesp.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -801,15 +801,17 @@ def returnScipySignalLTI(self, strict=True):
801801
----------
802802
strict : bool, optional
803803
True (default):
804-
`ssobject` must be continuous or discrete. `tfobject.dt` cannot
805-
be None.
804+
The timebase `ssobject.dt` cannot be None; it must
805+
be continuous (0) or discrete (True or > 0).
806806
False:
807-
if `ssobject.dt` is None, continuous time signal.StateSpace
808-
objects are returned
807+
If `ssobject.dt` is None, continuous time scipy.signal.lti
808+
objects are returned.
809809
810810
Returns
811811
-------
812812
out : list of list of scipy.signal.StateSpace
813+
continuous time (inheriting from scipy.signal.lti)
814+
or discrete time (inheriting from scipy.signal.dlti) SISO objects
813815
"""
814816
if strict and self.dt is None:
815817
raise ValueError("with strict=True, dt cannot be None")

control/xferfcn.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,7 @@ def minreal(self, tol=None):
803803
return TransferFunction(num, den, self.dt)
804804

805805
def returnScipySignalLTI(self, strict=True):
806-
"""Return a list of a list of scipy.signal.lti objects.
806+
"""Return a list of a list of SISO scipy.signal.lti objects.
807807
808808
For instance,
809809
@@ -817,15 +817,17 @@ def returnScipySignalLTI(self, strict=True):
817817
----------
818818
strict : bool, optional
819819
True (default):
820-
`tfobject` must be continuous or discrete.
821-
`tfobject.dt`cannot be None.
820+
The timebase `tfobject.dt` cannot be None; it must be
821+
continuous (0) or discrete (True or > 0).
822822
False:
823-
if `tfobject.dt` is None, continuous time signal.TransferFunction
824-
objects are is returned
823+
if `tfobject.dt` is None, continuous time scipy.signal.lti
824+
objects are returned
825825
826826
Returns
827827
-------
828828
out : list of list of scipy.signal.TransferFunction
829+
continuous time (inheriting from scipy.signal.lti)
830+
or discrete time (inheriting from scipy.signal.dlti) SISO objects
829831
"""
830832
if strict and self.dt is None:
831833
raise ValueError("with strict=True, dt cannot be None")

0 commit comments

Comments
 (0)