Skip to content

Commit 4a911e1

Browse files
sblelongkellertuer
andauthored
Fix injectivity_radius documentation (#270)
* Fix injectivity_radius documentation --------- Co-authored-by: Ronny Bergmann <git@ronnybergmann.net>
1 parent 3544e47 commit 4a911e1

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

NEWS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [2.3.6] unreleased
9+
10+
### Fixed
11+
12+
* (documentation of the `injectivity_radius` function now displays clearer instructions for the implementation of a radius linked to a user's own `AbstractRetractionMethod`. (#270)
13+
814
## [2.3.5] 03/04/2026
915

1016
### Changed

src/ManifoldsBase.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -674,8 +674,8 @@ is injective for all tangent vectors shorter than ``d`` (i.e. has an inverse) fo
674674
if provided or all manifold points otherwise.
675675
676676
In order to dispatch on different retraction methods, please either implement
677-
`_injectivity_radius(M[, p], m::T)` for your retraction `R` or specifically `injectivity_radius_exp(M[, p])` for the exponential map.
678-
By default the variant with a point `p` assumes that the default (without `p`) can ve called as a lower bound.
677+
`_injectivity_radius(M[, p], m::T)` for your retraction `m` or specifically `injectivity_radius_exp(M[, p])` for the exponential map.
678+
By default the variant with a point `p` assumes that the default (without `p`) can be called as a lower bound.
679679
"""
680680
injectivity_radius(M::AbstractManifold)
681681
injectivity_radius(M::AbstractManifold, p) = injectivity_radius(M)

0 commit comments

Comments
 (0)