GeezerVison is showing github.com — Merge pull request #674 from bnavigator/fix-doc-escape · python-control/python-control@382a297
File treeExpand file treeCollapse file tree Open diff view settings Expand file treeCollapse file tree Open diff view settings Collapse file Copy file name to clipboardExpand all lines: control/bdalg.py +8-5Lines changed: 8 additions & 5 deletions | Original file line number | Diff line number | Diff line change |
|---|
| 62 | 62 |
| 63 | 63 |
| 64 | 64 | 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`. | 66 | 68 |
| 67 | 69 | Parameters | 68 | 70 | ---------- | @@ -107,8 +109,9 @@ def series(sys1, *sysn): | 107 | 109 |
| 108 | 110 |
| 109 | 111 | 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`). | 112 | 115 |
| 113 | 116 | Parameters | 114 | 117 | ---------- | @@ -252,9 +255,9 @@ def feedback(sys1, sys2=1, sign=-1): | 252 | 255 | return sys1.feedback(sys2, sign) | 253 | 256 |
| 254 | 257 | def append(*sys): | 255 | | - """append(sys1, sys2, ..., sysn) | | 258 | + """append(sys1, sys2, [..., sysn]) | 256 | 259 |
| 257 | | - Group models by appending their inputs and outputs | | 260 | + Group models by appending their inputs and outputs. | 258 | 261 |
| 259 | 262 | Forms an augmented system model, and appends the inputs and | 260 | 263 | outputs together. The system type will be the type of the first | |
Collapse file Copy file name to clipboardExpand all lines: doc/control.rst -10Lines changed: 0 additions & 10 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -71,16 +71,6 @@ Time domain simulation | 71 | 71 | step_response | 72 | 72 | phase_plot | 73 | 73 |
| 74 | | -Block diagram algebra | 75 | | -===================== | 76 | | -.. autosummary:: | 77 | | - :toctree: generated/ | 78 | | - | 79 | | - series | 80 | | - parallel | 81 | | - feedback | 82 | | - negate | 83 | | - | 84 | 74 | Control system analysis | 85 | 75 | ======================= | 86 | 76 | .. autosummary:: | |
|