Skip to content

Commit a5c2c01

Browse files
Merge pull request #197 from SciML/fb/cont
Fix continuous docstrings
2 parents ca8760b + 3fffafe commit a5c2c01

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/Blocks/continuous.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ end
175175
PI(;name, gainPI.k = 1.0, T, int.x = 0.0)
176176
177177
Textbook version of a PI-controller without actuator saturation and anti-windup measure.
178+
The proportional gain can be set with `gainPI.k`
178179
Initial value of integrator state `x` can be set with `int.x`
179-
Initial value of gain can be set with `gainPI.k`
180180
181181
# Parameters:
182182
@@ -290,12 +290,13 @@ See also [`LimPID`](@ref)
290290
end
291291

292292
"""
293-
LimPI(; name, T, Ta, k = 1.0, int__x = 0.0, u_max = 1.0, u_min = -u_max)
293+
LimPI(; name, k = 1.0, T, Ta, int__x = 0.0, u_max = 1.0, u_min = -u_max)
294294
295295
Text-book version of a PI-controller with actuator saturation and anti-windup measure.
296296
297297
# Parameters:
298298
299+
- `k`: Proportional gain
299300
- `T`: [s] Integrator time constant (T>0 required)
300301
- `Ta`: [s] Tracking time constant (Ta>0 required)
301302
@@ -471,7 +472,7 @@ where the transfer function for the derivative includes additional filtering, se
471472
end
472473

473474
"""
474-
StateSpace(A, B, C, D = 0; x = zeros(size(A,1)), u0 = zeros(size(B,2)), y0 = zeros(size(C,1)), name)
475+
StateSpace(A, B, C, D = 0; x = zeros(size(A,1)), u0 = zeros(size(B,2)), y0 = zeros(size(C,1)), name)
475476
476477
A linear, time-invariant state-space system on the form.
477478

0 commit comments

Comments
 (0)