unify docstring for return ScipySignalLTI · python-control/python-control@a3336a4

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")