Skip to content

Commit 07061e5

Browse files
committed
Update docu
1 parent 5159519 commit 07061e5

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

docs/src/winchcontroller.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ calc_v_set(wc::WinchController, v_act, force, f_low; v_set_pc=nothing)
6868
get_set_force(wc::WinchController)
6969
get_state(wc::WinchController)
7070
get_status(wc::WinchController)
71+
get_v_err(wc::WinchController)
7172
on_timer(wc::WinchController)
7273
```
7374

src/wc_components.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,6 @@ Compute and return the velocity error for the given `SpeedController` instance `
453453
# Returns
454454
- The velocity error `v_err` [m/s].
455455
If the controller is inactive, it returns `NaN`.
456-
457456
"""
458457
function get_v_err(sc::SpeedController)
459458
if sc.inactive

src/winchcontroller.jl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,18 @@ function get_status(wc::WinchController)
216216
result
217217
end
218218

219+
"""
220+
get_v_err(wc::WinchController)
221+
222+
Compute and return the velocity error for the given `WinchController` instance `sc`.
223+
224+
# Arguments
225+
- wc::[WinchController](@ref): The winch controller object for which the velocity error is to be calculated.
226+
227+
# Returns
228+
- The velocity error `v_err` [m/s].
229+
If the speed controller is inactive, it returns `NaN`.
230+
"""
219231
function get_v_err(wc::WinchController)
220232
get_v_err(wc.sc)
221233
end

0 commit comments

Comments
 (0)