Skip to content

Commit d0ae483

Browse files
committed
doc: mention the debug log dictionary in the docstrings
1 parent 3721d8c commit d0ae483

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

src/controller/execute.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,8 @@ If supported by `mpc.optim`, it warm-starts the solver at:
491491
where ``\mathbf{Δu}_{k-1}(k+j)`` is the input increment for time ``k+j`` computed at the
492492
last control period ``k-1``. It then calls `JuMP.optimize!(mpc.optim)` and extract the
493493
solution. A failed optimization prints an `@error` log in the REPL and returns the
494-
warm-start value.
494+
warm-start value. A failed optimization also prints [`getinfo`](@ref) results in
495+
the debug log [if activated](https://docs.julialang.org/en/v1/stdlib/Logging/#Example:-Enable-debug-level-messages).
495496
"""
496497
function optim_objective!(mpc::PredictiveController{NT}) where {NT<:Real}
497498
model, optim = mpc.estim.model, mpc.optim

src/estimator/mhe/execute.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,8 @@ If supported by `estim.optim`, it warm-starts the solver at:
369369
where ``\mathbf{ŵ}_{k-1}(k-j)`` is the input increment for time ``k-j`` computed at the
370370
last time step ``k-1``. It then calls `JuMP.optimize!(estim.optim)` and extract the
371371
solution. A failed optimization prints an `@error` log in the REPL and returns the
372-
warm-start value.
372+
warm-start value. A failed optimization also prints [`getinfo`](@ref) results in
373+
the debug log [if activated](https://docs.julialang.org/en/v1/stdlib/Logging/#Example:-Enable-debug-level-messages).
373374
"""
374375
function optim_objective!(estim::MovingHorizonEstimator{NT}) where NT<:Real
375376
model, optim = estim.model, estim.optim

0 commit comments

Comments
 (0)