Skip to content

Commit

Permalink
Fixed broken docstring bullets for AbstractCliffordNumber
Browse files Browse the repository at this point in the history
  • Loading branch information
brainandforce committed Aug 8, 2024
1 parent c9132ab commit e170311
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### Fixed
- `OddCliffordNumber` constructors now fail to operate on scalars unless there is exactly one odd
element in the algebra.
- Broken bullets in `AbstractCliffordNumber` docstring.

## [0.1.6] - 2024-06-27

Expand Down
12 changes: 6 additions & 6 deletions src/abstract.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ arrays or other data structures.
All subtypes `C` of `AbstractCliffordNumber{Q}` must implement the following functions:
* `CliffordNumbers.similar_type(::Type{C}, ::Type{T}, ::Type{Q}) where {C,T,Q}` should construct a
new type similar to `C` which subtypes `AbstractCliffordNumber{Q,T}` that may serve as a
constructor.
new type similar to `C` which subtypes `AbstractCliffordNumber{Q,T}` that may serve as a
constructor.
* `Base.getindex(x::C, b::BitIndex{Q})` should allow one to recover the coefficients associated
with each basis blade represented by `C`.
with each basis blade represented by `C`.
* `nblades(::Type{C})` should be defined to return the number of basis blades represented by the
type. By default, `nblades(x::AbstractCliffordNumber) = nblades(typeof(x))`.
type. By default, `nblades(x::AbstractCliffordNumber) = nblades(typeof(x))`.
* `Base.Tuple(x::C)` should return the tuple used to construct `x`. The fallback is
`getfield(x, :data)::Tuple`, so any type declared with a `NTuple` field named `data` should have
this defined automatically.
`getfield(x, :data)::Tuple`, so any type declared with a `NTuple` field named `data` should have
this defined automatically.
"""
abstract type AbstractCliffordNumber{Q,T<:BaseNumber} <: Number
end
Expand Down

0 comments on commit e170311

Please sign in to comment.