Skip to content

Commit 951606a

Browse files
committed
escape directive/ellipsis in function summary
1 parent a187c98 commit 951606a

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

control/bdalg.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@
6262

6363

6464
def series(sys1, *sysn):
65-
"""Return the series connection (sysn \\* ... \\*) sys2 \\* sys1
65+
r"""series(sys1, sys2, [..., sysn])
66+
67+
Return the series connection (`sysn` \* ...\ \*) `sys2` \* `sys1`.
6668
6769
Parameters
6870
----------
@@ -107,8 +109,9 @@ def series(sys1, *sysn):
107109

108110

109111
def parallel(sys1, *sysn):
110-
"""
111-
Return the parallel connection sys1 + sys2 (+ ... + sysn)
112+
r"""parallel(sys1, sys2, [..., sysn])
113+
114+
Return the parallel connection `sys1` + `sys2` (+ ...\ + `sysn`).
112115
113116
Parameters
114117
----------
@@ -252,9 +255,9 @@ def feedback(sys1, sys2=1, sign=-1):
252255
return sys1.feedback(sys2, sign)
253256

254257
def append(*sys):
255-
"""append(sys1, sys2, ..., sysn)
258+
"""append(sys1, sys2, [..., sysn])
256259
257-
Group models by appending their inputs and outputs
260+
Group models by appending their inputs and outputs.
258261
259262
Forms an augmented system model, and appends the inputs and
260263
outputs together. The system type will be the type of the first

0 commit comments

Comments
 (0)