minor fixup to included Base-extended docs

thchr · Dec 18, 2023 · 3fc6f7a · 3fc6f7a
1 parent 10514b8
commit 3fc6f7a
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/src/Crystalline.jl b/src/Crystalline.jl
@@ -84,7 +84,8 @@ export @S_str, spacegroup, compose,
        pointgroup,
        reduce_ops,
        issubgroup, isnormal,
-       generate, generators
+       generate, generators,
+       position # to appear in docs, must be re-exported, even though it extends Base
 
 include("conjugacy.jl") # construction of conjugacy classes
 export classes, is_abelian

diff --git a/src/types.jl b/src/types.jl
@@ -587,7 +587,7 @@ $(TYPEDSIGNATURES)
 
 Return the cosets of a `SiteGroup` `g`.
 
-The cosets generate the orbit of the Wyckoff position `position(g)` (see
+The cosets generate the orbit of the Wyckoff position [`position(g)`](@ref) (see also
 [`orbit(::SiteGroup)`](@ref)) and furnish a left-coset decomposition of the underlying space
 group, jointly with the operations in `g` itself.
 """

diff --git a/src/wyckoff.jl b/src/wyckoff.jl
@@ -209,7 +209,7 @@ return those `SiteGroup`s that are associated with a maximal Wyckoff positions.
 
 Results are returned as a `view` into the input vector (i.e. as an 
 `AbstractVector{<:SiteGroup}`). The associated Wyckoff positions can be retrieved via
-`position`.
+[`position`](@ref).
 
 ## Definition
 A Wyckoff position is maximal if its site symmetry group has higher order than the site