Skip to content

Commit

Permalink
Added documentation for KPoint
Browse files Browse the repository at this point in the history
  • Loading branch information
brainandforce committed Nov 29, 2023
1 parent cb18235 commit 05915d5
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/vectors.jl
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ struct ShiftVector{S<:BySpace,D,T<:Real} <: StaticVector{D,T}
end

const KPoint = ShiftVector{ByReciprocalSpace}
@doc (@doc ShiftVector) KPoint

# Needed to resolve method ambiguities
ShiftVector{S,D,T}(::StaticArray, ::Real = 1) where {S,D,T} = error("Argument must be a vector.")
Expand Down

0 comments on commit 05915d5

Please sign in to comment.