Skip to content

Commit 705ca7c

Browse files
committed
docs fixes
1 parent e3c44dd commit 705ca7c

File tree

4 files changed

+8
-9
lines changed

4 files changed

+8
-9
lines changed

docs/src/lib/sectors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Irrep
3131

3232
## Methods for defining and characterizing `Sector` subtypes
3333
```@docs
34-
Base.one(::Sector)
35-
dual(::Sector)
34+
unit(::Sector)
35+
dual
3636
Nsymbol
3737
3838
Fsymbol
3939
Rsymbol
4040
Bsymbol
4141
dim(::Sector)
42-
frobeniusschur
42+
frobenius_schur_phase
4343
twist(::Sector)
4444
Base.isreal(::Type{<:Sector})
4545
TensorKitSectors.sectorscalartype

docs/src/lib/spaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ The following methods act specifically on `ElementarySpace` spaces:
8686

8787
```@docs
8888
isdual
89-
dual
89+
dual(::VectorSpace)
9090
conj
9191
flip
9292
9393
94-
zero(::ElementarySpace)
94+
zerospace
9595
unitspace
9696
supremum
9797
infimum

docs/src/man/sectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ For practical reasons, we also require some additional methods to be defined:
171171

172172
Further information, such as the quantum dimensions ``d_a`` and Frobenius-Schur indicator
173173
``χ_a`` (only if ``a == \overline{a}``) are encoded in the F-symbol. They are obtained as
174-
[`dim(a)`](@ref) and [`frobeniusschur(a)`](@ref). These functions have default definitions
174+
[`dim(a)`](@ref) and [`frobenius_schur_phase(a)`](@ref). These functions have default definitions
175175
which extract the requested data from `Fsymbol(a, conj(a), a, a, one(a), one(a))`, but they
176176
can be overloaded in case the value can be computed more efficiently.
177177

src/spaces/vectorspaces.jl

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,12 @@ function space end
6666
Return the total dimension of the vector space `V` as an Int.
6767
""" dim(::VectorSpace)
6868

69-
"""
69+
@doc """
7070
dual(V::VectorSpace) -> VectorSpace
7171
7272
Return the dual space of `V`; also obtained via `V'`. This should satisfy
7373
`dual(dual(V)) == V`. It is assumed that `typeof(V) == typeof(V')`.
74-
"""
75-
function dual end
74+
""" dual(::VectorSpace)
7675

7776
# convenience definitions:
7877
Base.adjoint(V::VectorSpace) = dual(V)

0 commit comments

Comments
 (0)