Skip to content

Commit 796acad

Browse files
committed
switch docstring example to use system names
1 parent 91aac8f commit 796acad

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

control/nlsys.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,15 +1017,15 @@ def signal_table(self, show_names=False):
10171017
10181018
Examples
10191019
--------
1020-
>>> P = ct.ss(1,1,1,0, inputs='u', outputs='y')
1021-
>>> C = ct.tf(10, [.1, 1], inputs='e', outputs='u')
1020+
>>> P = ct.ss(1,1,1,0, inputs='u', outputs='y', name='P')
1021+
>>> C = ct.tf(10, [.1, 1], inputs='e', outputs='u', name='C')
10221022
>>> L = ct.interconnect([C, P], inputs='e', outputs='y')
1023-
>>> L.signal_table() # doctest: +SKIP
1023+
>>> L.signal_table(show_names=True) # doctest: +SKIP
10241024
signal | source | destination
10251025
--------------------------------------------------------------
1026-
e | input | system 0
1027-
u | system 0 | system 1
1028-
y | system 1 | output
1026+
e | input | C
1027+
u | C | P
1028+
y | P | output
10291029
"""
10301030

10311031
spacing = 26
@@ -1053,12 +1053,12 @@ def signal_table(self, show_names=False):
10531053
for idx, sys in enumerate(self.syslist):
10541054
loc = sys.find_output(signal_label)
10551055
if loc is not None:
1056-
if not sources.endswith(' '):
1056+
if not sources.endswith(', '):
10571057
sources += ', '
10581058
sources += sys.name if show_names else 'system ' + str(idx)
10591059
loc = sys.find_input(signal_label)
10601060
if loc is not None:
1061-
if not dests.endswith(' '):
1061+
if not dests.endswith(', '):
10621062
dests += ', '
10631063
dests += sys.name if show_names else 'system ' + str(idx)
10641064
print(sources.ljust(spacing), end='')
@@ -2582,15 +2582,15 @@ def signal_table(sys, show_names=False):
25822582
25832583
Examples
25842584
--------
2585-
>>> P = ct.ss(1,1,1,0, inputs='u', outputs='y')
2586-
>>> C = ct.tf(10, [.1, 1], inputs='e', outputs='u')
2585+
>>> P = ct.ss(1,1,1,0, inputs='u', outputs='y', name='P')
2586+
>>> C = ct.tf(10, [.1, 1], inputs='e', outputs='u', name='C')
25872587
>>> L = ct.interconnect([C, P], inputs='e', outputs='y')
2588-
>>> ct.signal_table(L) # doctest: +SKIP
2588+
>>> L.signal_table(show_names=True) # doctest: +SKIP
25892589
signal | source | destination
25902590
--------------------------------------------------------------
2591-
e | input | system 0
2592-
u | system 0 | system 1
2593-
y | system 1 | output
2591+
e | input | C
2592+
u | C | P
2593+
y | P | output
25942594
"""
25952595
assert isinstance(sys, InterconnectedSystem), "system must be"\
25962596
"an InterconnectedSystem."

0 commit comments

Comments
 (0)