From 87af22a1d9c29aad5275ca25e6a053066a8cdce3 Mon Sep 17 00:00:00 2001 From: Ronny Bergmann Date: Fri, 11 Oct 2024 18:23:48 +0200 Subject: [PATCH] Fix docs. --- docs/src/interface/group.md | 1 + src/documentation_glossary.jl | 5 +++++ src/interface.jl | 4 ++-- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/src/interface/group.md b/docs/src/interface/group.md index bb08b501..b1dbdb16 100644 --- a/docs/src/interface/group.md +++ b/docs/src/interface/group.md @@ -30,6 +30,7 @@ exp! identity_element identity_element! is_identity +isapprox inv(::LieGroup, ::Any) inv! diff_inv diff --git a/src/documentation_glossary.jl b/src/documentation_glossary.jl index 1fa9cf45..bbce5874 100644 --- a/src/documentation_glossary.jl +++ b/src/documentation_glossary.jl @@ -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`)") # diff --git a/src/interface.jl b/src/interface.jl index df60602d..06df3343 100644 --- a/src/interface.jl +++ b/src/interface.jl @@ -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. """