Unify docs.

JuliaManifolds · Oct 19, 2024 · 03fc158 · 03fc158
1 parent 1e60559
commit 03fc158
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 7 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -5,7 +5,7 @@ All notable Changes to the Julia package `LieGroups.jl` will be documented in th
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - unreleased
+## [0.1.0] unreleased
 
 Everything denoted by “formerly” refers to the previous name in [`Manifolds.jl`](https://juliamanifolds.github.io/Manifolds.jl/stable/).
 

diff --git a/docs/src/interface/actions.md b/docs/src/interface/actions.md
@@ -1,4 +1,4 @@
-# An Interface Actions on Lie groups
+# An Interface for Lie group actions
 
 ```@autodocs
 Modules = [LieGroups]

diff --git a/docs/src/interface/algebra.md b/docs/src/interface/algebra.md
@@ -1,4 +1,4 @@
-# The interface for Lie algebras
+# An interface for Lie algebras
 
 ```@docs
 LieAlgebra

diff --git a/docs/src/interface/group.md b/docs/src/interface/group.md
@@ -1,4 +1,4 @@
-# The interface for Lie Groups
+# An interface for Lie groups
 
 ```@docs
 LieGroup

diff --git a/docs/src/interface/operations.md b/docs/src/interface/operations.md
@@ -1,5 +1,5 @@
 
-# Lie group operations
+# An interface for Lie group operations
 
 ```@docs
 AbstractGroupOperation

diff --git a/docs/styles/config/vocabularies/LieGroups/accept.txt b/docs/styles/config/vocabularies/LieGroups/accept.txt
@@ -1,3 +1,4 @@
+julia
 LieGroups.jl
 Lie algebra
 Lie algebras

diff --git a/src/LieGroups.jl b/src/LieGroups.jl
@@ -5,7 +5,8 @@ using ManifoldsBase, Manifolds, LinearAlgebra
 #
 #
 # = Compatibility (and a bit of type piracy for now)
-# The following imports shall be removed once Manifolds.jl does no longer define them (in 0.11)
+# The following imports are necessary to use Manifolds.jl 0.10 with Lie Groups
+# The line is removed when the Groups are removed from possibly 0.11
 import Manifolds: apply, apply!, identity_element, is_identity, compose
 # Both define the following structs, so these for now lead to asking for explicit prefixes
 # Manifolds: Identity, TranslationGroup

diff --git a/test/LieGroupsTestSuite.jl/LieGroupsTestSuite.jl b/test/LieGroupsTestSuite.jl/LieGroupsTestSuite.jl
@@ -559,7 +559,7 @@ function test_LieGroup(G::LieGroup, properties::Dict, expectations::Dict=Dict())
 
         #
         #
-        # --- I
+        # --- `I`
         if any(in.([inv_left_compose, inv_right_compose], Ref(functions)))
             vl = get(expectations, :inv_left_compose, missing)
             vr = get(expectations, :inv_right_compose, missing)