Skip to content

Commit

Permalink
Fix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Oct 11, 2024
1 parent 7b87074 commit 87af22a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/src/interface/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ exp!
identity_element
identity_element!
is_identity
isapprox
inv(::LieGroup, ::Any)
inv!
diff_inv
Expand Down
5 changes: 5 additions & 0 deletions src/documentation_glossary.jl
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ define!(
:AbstractManifold,
"[`AbstractManifold`](@extref `ManifoldsBase.AbstractManifold`)",
)
define!(
:Link,
:isapprox,
"[`isapprox`](@extref `Base.isapprox-Tuple{AbstractManifold, Any, Any, Any}`)",
)
define!(:Link, :TangentSpace, "[`TangentSpace`](@extref `ManifoldsBase.TangentSpace`)")

#
Expand Down
4 changes: 2 additions & 2 deletions src/interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -442,8 +442,8 @@ diff_inv!(G::LieGroup, Y, g, X)
isapprox(M::LieGroup, g, h; kwargs...)
Check if points `g` and `h` from [`LieGroup`](@ref) are approximately equal.
this function calls the corresponding [`isapprox`](@exref `ManifoldsBase.isapprox`)
on the $(_link(:AbstractManifold)) after handling the cases where one or more
this function calls the corresponding $(_link(:isapprox)) on the $(_link(:AbstractManifold))
after handling the cases where one or more
of the points are the [`Identity`](@ref).
All keyword argments are passed to this function as well.
"""
Expand Down

0 comments on commit 87af22a

Please sign in to comment.