quantum sys utils docstrings

kestrelquantum · Nov 21, 2024 · 3ac1ab5 · 3ac1ab5
1 parent 3df6ad7
commit 3ac1ab5
Show file tree

Hide file tree

Showing 6 changed files with 130 additions and 106 deletions.
diff --git a/src/composite_quantum_systems.jl b/src/composite_quantum_systems.jl
@@ -255,4 +255,8 @@ function (csys::CompositeQuantumSystem)(;
     )
 end
 
+# ****************************************************************************** #
+
+# TODO: Implement `CompositeQuantumSystem` tests
+
 end
diff --git a/src/embedded_operators.jl b/src/embedded_operators.jl
@@ -555,7 +555,7 @@ end
 get_iso_vec_leakage_indices(op::EmbeddedOperator; kwargs...) =
     get_iso_vec_leakage_indices(op.subspace, size(op, 1); kwargs...)
 
-# =========================================================================== #
+# ****************************************************************************** #
 
 @testitem "Embedded operator" begin
     using LinearAlgebra: I

diff --git a/src/isomorphisms.jl b/src/isomorphisms.jl
@@ -248,7 +248,6 @@ function ad_vec(H::AbstractMatrix{R}; anti::Bool=false) where R <: Number
     return kron(Id, H) - (-1)^anti * kron(conj(H)', Id)
 end
 
-
 # *************************************************************************** #
 
 @testitem "Test ket isomorphisms" begin

diff --git a/src/quantum_object_utils.jl b/src/quantum_object_utils.jl
@@ -272,7 +272,7 @@ function create(levels::Int)
     return collect(annihilate(levels)')
 end
 
-# ============================================================================= #
+# ****************************************************************************** #
 
 @testitem "Test ket_from_bitstring function" begin
     @test ket_from_bitstring("0") == [1, 0]
-Original file line number
+Diff line change
@@ Expand Up / @@ -255,4 +255,8 @@ function (csys::CompositeQuantumSystem)(; @@
         )
     end
+    # ****************************************************************************** #
+    # TODO: Implement `CompositeQuantumSystem` tests
     end