Skip to content

Documentation updates #633

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
murrayrm merged 7 commits into from
Jun 16, 2021
Merged

Documentation updates #633

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fb65459
DOC: fix forced_response return arguments in documentation
murrayrm Jun 12, 2021
d89dfd8
DOC: update iosys docstrings - params not optional for updfcn, outfcn
murrayrm Jun 12, 2021
695cdfc
DOC: fix LTI system attribute docstrings, add __call__, PEP8 cleanup
murrayrm Jun 12, 2021
bf2472f
DOC: move constructor docs from __init__ to class; remove attr docs
murrayrm Jun 12, 2021
70a6cf9
TRV: fix typos pointed out by @namannimmo10
murrayrm Jun 13, 2021
bda7d82
DOC: fix inconsistencies in class constructor + class list documentation
murrayrm Jun 15, 2021
866a07c
TRV: fix typos in FRD docstring
murrayrm Jun 15, 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
Prev Previous commit
Next Next commit
DOC: update iosys docstrings - params not optional for updfcn, outfcn
  • Loading branch information
@murrayrm
murrayrm committed Jun 12, 2021
commit d89dfd863dafc901e60254da75ef353f789905d5
8 changes: 4 additions & 4 deletions control/iosys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,17 +790,17 @@ def __init__(self, updfcn, outfcn=None, inputs=None, outputs=None,
updfcn : callable
Function returning the state update function

`updfcn(t, x, u[, param]) -> array`
`updfcn(t, x, u, params) -> array`

where `x` is a 1-D array with shape (nstates,), `u` is a 1-D array
with shape (ninputs,), `t` is a float representing the currrent
time, and `param` is an optional dict containing the values of
parameters used by the function.
time, and `params` is a dict containing the values of parameters
used by the function.

outfcn : callable
Function returning the output at the given state

`outfcn(t, x, u[, param]) -> array`
`outfcn(t, x, u, params) -> array`

where the arguments are the same as for `upfcn`.

Expand Down