From f70b320f8cfd3c49ddc0c824134f800a5c9c5074 Mon Sep 17 00:00:00 2001
From: Fe-r-oz <feroz.ahmad.email@gmail.com>
Date: Fri, 23 Aug 2024 21:56:03 +0500
Subject: [PATCH] improving documentation for apply

---
 src/nonclifford.jl | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/src/nonclifford.jl b/src/nonclifford.jl
index 581906841..cc2fc475f 100644
--- a/src/nonclifford.jl
+++ b/src/nonclifford.jl
@@ -89,6 +89,31 @@ function _stabmixdestab(mixeddestab, d)
     p
 end
 
+"""
+Updates the generalized stabilizer `τ = (χ, B(S, D))` by applying a Clifford gate `G`,
+where `χ` represents the density matrix and `B(S, D)` denotes the stabilizer basis in
+which `χ` is expressed.
+
+```jldoctest
+julia> sm = GeneralizedStabilizer(S"-X")
+A mixture ∑ ϕᵢⱼ Pᵢ ρ Pⱼ† where ρ is
+𝒟ℯ𝓈𝓉𝒶𝒷
++ Z
+𝒮𝓉𝒶𝒷
+- X
+with ϕᵢⱼ | Pᵢ | Pⱼ:
+ 1.0+0.0im | + _ | + _
+
+julia> apply!(sm, CliffordOperator(sHadamard))
+A mixture ∑ ϕᵢⱼ Pᵢ ρ Pⱼ† where ρ is
+𝒟ℯ𝓈𝓉𝒶𝒷
++ X
+𝒮𝓉𝒶𝒷
+- Z
+with ϕᵢⱼ | Pᵢ | Pⱼ:
+ 1.0+0.0im | + _ | + _
+```
+"""
 function apply!(state::GeneralizedStabilizer, gate::AbstractCliffordOperator) # TODO conjugate also the destabs
     apply!(state.stab, gate)
     state