Skip to content

Fix doc escape #674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2021
Merged

Fix doc escape #674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a187c98
remove duplicate block: interconnections covers bdalg
bnavigator Nov 26, 2021
951606a
escape directive/ellipsis in function summary
bnavigator Nov 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions control/bdalg.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down Expand Up @@ -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
----------
Expand Down Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions doc/control.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down