Skip to content

Commit d89dfd8

Browse files
committed
DOC: update iosys docstrings - params not optional for updfcn, outfcn
1 parent fb65459 commit d89dfd8

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

control/iosys.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -790,17 +790,17 @@ def __init__(self, updfcn, outfcn=None, inputs=None, outputs=None,
790790
updfcn : callable
791791
Function returning the state update function
792792
793-
`updfcn(t, x, u[, param]) -> array`
793+
`updfcn(t, x, u, params) -> array`
794794
795795
where `x` is a 1-D array with shape (nstates,), `u` is a 1-D array
796796
with shape (ninputs,), `t` is a float representing the currrent
797-
time, and `param` is an optional dict containing the values of
798-
parameters used by the function.
797+
time, and `params` is a dict containing the values of parameters
798+
used by the function.
799799
800800
outfcn : callable
801801
Function returning the output at the given state
802802
803-
`outfcn(t, x, u[, param]) -> array`
803+
`outfcn(t, x, u, params) -> array`
804804
805805
where the arguments are the same as for `upfcn`.
806806

0 commit comments

Comments
 (0)