From a187c98d3826ff990bed0d7dbdfc614fb3285971 Mon Sep 17 00:00:00 2001 From: Ben Greiner Date: Sat, 27 Nov 2021 00:08:58 +0100 Subject: [PATCH 1/2] remove duplicate block: interconnections covers bdalg --- doc/control.rst | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/doc/control.rst b/doc/control.rst index a3e28881b..0dc62f0ee 100644 --- a/doc/control.rst +++ b/doc/control.rst @@ -71,16 +71,6 @@ Time domain simulation step_response phase_plot -Block diagram algebra -===================== -.. autosummary:: - :toctree: generated/ - - series - parallel - feedback - negate - Control system analysis ======================= .. autosummary:: From 951606a3035f52c53e0211cf5866e7afabe15bc3 Mon Sep 17 00:00:00 2001 From: Ben Greiner Date: Sat, 27 Nov 2021 00:09:36 +0100 Subject: [PATCH 2/2] escape directive/ellipsis in function summary --- control/bdalg.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/control/bdalg.py b/control/bdalg.py index f6d89f7be..d1baaa410 100644 --- a/control/bdalg.py +++ b/control/bdalg.py @@ -62,7 +62,9 @@ def series(sys1, *sysn): - """Return the series connection (sysn \\* ... \\*) sys2 \\* sys1 + r"""series(sys1, sys2, [..., sysn]) + + Return the series connection (`sysn` \* ...\ \*) `sys2` \* `sys1`. Parameters ---------- @@ -107,8 +109,9 @@ def series(sys1, *sysn): def parallel(sys1, *sysn): - """ - Return the parallel connection sys1 + sys2 (+ ... + sysn) + r"""parallel(sys1, sys2, [..., sysn]) + + Return the parallel connection `sys1` + `sys2` (+ ...\ + `sysn`). Parameters ---------- @@ -252,9 +255,9 @@ def feedback(sys1, sys2=1, sign=-1): return sys1.feedback(sys2, sign) def append(*sys): - """append(sys1, sys2, ..., sysn) + """append(sys1, sys2, [..., sysn]) - Group models by appending their inputs and outputs + Group models by appending their inputs and outputs. Forms an augmented system model, and appends the inputs and outputs together. The system type will be the type of the first