add warning about the cumulant expansion

benneti · benneti · commit f8af3d7b3456 · 2024-12-11T20:15:57.000+01:00
diff --git a/src/fock.jl b/src/fock.jl
@@ -48,6 +48,9 @@ end
 
 Bosonic operator on a [`FockSpace`](@ref) representing the quantum harmonic
 oscillator ground state projection.
+
+Warning: The ground state projection is not meant to be used in the cumulant
+ expansion.
 """
 struct GroundStateProjection{H<:HilbertSpace,S,A,M} <: QSym
     hilbert::H
