Skip to content

Commit

Permalink
extref fix?
Browse files Browse the repository at this point in the history
  • Loading branch information
mateuszbaran committed Dec 11, 2024
1 parent 52473a1 commit bfbc817
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/plans/constrained_plan.jl
Original file line number Diff line number Diff line change
Expand Up @@ -992,14 +992,15 @@ g_i(p) ≤ 0, \text{ for all } i=1,…,m\quad\text{ and }\quad h_j(p) = 0, \text
```
# Keyword arguments
* `check_point::Bool=true`: whether to also verify that ``p∈\mathcal M` holds, using [`is_point`](@extref `ManifoldsBase.is_point`)
* `check_point::Bool=true`: whether to also verify that ``p∈\mathcal M` holds, using [`is_point`](@extref ManifoldsBase :jl:method:`ManifoldsBase.is_point-Tuple{ValidationManifold, Any}`)
* `error::Symbol=:none`: if the point is not feasible, this symbol determines how to report the error.
* `:error`: throws an error
* `:info`: displays the error message as an @info
* `:none`: (default) the function just returns true/false
* `:warn`: displays the error message as a @warning.
The keyword `error=` and all other `kwargs...` are passed on to [`is_point`](@extref `ManifoldsBase.is_point`) if the point is verfied (see `check_point`).
The keyword `error=` and all other `kwargs...` are passed on to [`is_point`](@extref ManifoldsBase :jl:method:`ManifoldsBase.is_point-Tuple{ValidationManifold, Any}`)
if the point is verfied (see `check_point`).
All other keywords are passed on to `is_poi`
"""
Expand Down

0 comments on commit bfbc817

Please sign in to comment.