From 0825a97a18528db08813a5e2dfbea84ff7a84da4 Mon Sep 17 00:00:00 2001 From: Yi-Te Huang Date: Tue, 4 Jun 2024 21:37:50 +0800 Subject: [PATCH] fix docstring --- src/qobj/states.jl | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/qobj/states.jl b/src/qobj/states.jl index b9b11446..a011467a 100644 --- a/src/qobj/states.jl +++ b/src/qobj/states.jl @@ -26,14 +26,15 @@ end basis(N::Int, pos::Int = 0; dims::Vector{Int}=[N]) Generates a fock state like [`fock`](@ref). + +It is also possible to specify the list of dimensions `dims` if different subsystems are present. """ basis(N::Int, pos::Int = 0; dims::Vector{Int} = [N]) = fock(N, pos, dims = dims) @doc raw""" coherent(N::Real, α::Number) -Generates a coherent state ``\ket{\alpha}``, which is defined as an eigenvector of the -bosonic annihilation operator ``\hat{a} \ket{\alpha} = \alpha \ket{\alpha}``. +Generates a coherent state ``\ket{\alpha}``, which is defined as an eigenvector of the bosonic annihilation operator ``\hat{a} \ket{\alpha} = \alpha \ket{\alpha}``. """ function coherent(N::Real, α::T) where {T<:Number} a = destroy(N)