Skip to content

Commit cc3fb2f

Browse files
committed
Update __truediv__ docstring for InputOutputSystem and StateSpace
1 parent 0efae63 commit cc3fb2f

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

‎control/iosys.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,9 @@ def __neg__(sys):
347347
return newsys
348348

349349
def __truediv__(sys2, sys1):
350-
"""Multiply two input/output systems (series interconnection)"""
350+
"""Division of input/output systems
351+
352+
Only division by scalars and arrays of scalars is supported"""
351353
# Note: order of arguments is flipped so that self = sys2,
352354
# corresponding to the ordering convention of sys2 * sys1
353355

‎control/statesp.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -796,7 +796,11 @@ def __rmul__(self, other):
796796

797797
# TODO: general __truediv__, and __rtruediv__; requires descriptor system support
798798
def __truediv__(self, other):
799-
"""Divide a StateSpace object; only division by scalars is supported"""
799+
"""Division of StateSpace systems
800+
801+
Only division by TFs, FRDs, scalars, and arrays of scalars is
802+
supported.
803+
"""
800804
if not isinstance(other, (LTI, NamedIOSystem)):
801805
return self * (1/other)
802806
else:

0 commit comments

Comments
 (0)