Skip to content

Fixed a couple of typos in documentation #775

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
Oct 8, 2022
Merged

Fixed a couple of typos in documentation #775

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
ffee2ac
Fixed a typo in conventions.rst
fredrhen Oct 7, 2022
461c7c3
Fixed more errors when compiling the documentation
fredrhen Oct 7, 2022
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
5 changes: 2 additions & 3 deletions control/iosys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2242,7 +2242,7 @@ def ss(*args, **kwargs):
Convert a linear system into space system form. Always creates a
new system, even if sys is already a state space system.

``ss(updfcn, outfucn)```
``ss(updfcn, outfucn)``
Create a nonlinear input/output system with update function ``updfcn``
and output function ``outfcn``. See :class:`NonlinearIOSystem` for
more information.
Expand All @@ -2269,8 +2269,7 @@ def ss(*args, **kwargs):
Everything that the constructor of :class:`numpy.matrix` accepts is
permissible here too.

``ss(args, inputs=['u1', ..., 'up'], outputs=['y1', ..., 'yq'],
states=['x1', ..., 'xn'])
``ss(args, inputs=['u1', ..., 'up'], outputs=['y1', ..., 'yq'], states=['x1', ..., 'xn'])``
Create a system with named input, output, and state signals.

Parameters
Expand Down
2 changes: 1 addition & 1 deletion control/passivity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def ispassive(sys, ofp_index=0, ifp_index=0):
guaranteed to have an output of True (the system might not be passive with
both indices at the same time).

For more details, see [1].
For more details, see [1]_.

References
----------
Expand Down
2 changes: 2 additions & 0 deletions control/sisotool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ def rootlocus_pid_designer(plant, gain='P', sign=+1, input_signal='r',
derivative terms are given instead by Kp, Ki*dt/2*(z+1)/(z-1), and
Kd/dt*(z-1)/z, respectively.

::

------> C_ff ------ d
| | |
r | e V V u y
Expand Down
2 changes: 1 addition & 1 deletion doc/conventions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ of linear time-invariant (LTI) systems:

where u is the input, y is the output, and x is the state.

To create a state space system, use the :fun:`ss` function:
To create a state space system, use the :func:`ss` function:

sys = ct.ss(A, B, C, D)

Expand Down