Export AbstractFourMomentum (#66)

As discussed here: QEDjl-project/QEDprocesses.jl#68 (comment)
QEDjl-project · May 27, 2024 · a394e86 · a394e86
1 parent 326184d
commit a394e86
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/QEDbase.jl b/src/QEDbase.jl
@@ -29,7 +29,8 @@ export setTransverseMass!, setMt!
 export setRapidity!
 
 export AbstractLorentzVector, SLorentzVector, MLorentzVector, dot
-export SFourMomentum, MFourMomentum, isonshell, assert_onshell
+export AbstractFourMomentum, SFourMomentum, MFourMomentum
+export isonshell, assert_onshell
 
 export BiSpinor, AdjointBiSpinor, DiracMatrix, mul
 export AbstractDiracVector, AbstractDiracMatrix

diff --git a/src/four_momentum.jl b/src/four_momentum.jl
@@ -1,6 +1,9 @@
 """
-SFourMomentum type
+    AbstractFourMomentum
 
+Abstract base type for four-momentas, representing one energy and three spacial components.
+
+Also see: [`SFourMomentum`](@ref)
 """
 
 abstract type AbstractFourMomentum <: AbstractLorentzVector{Float64} end