fix docstring for Qobj and QobjEvo

qutip · Dec 18, 2024 · 314a611 · 314a611
1 parent 11341bf
commit 314a611
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -13,8 +13,8 @@ using CairoMakie
 DocMeta.setdocmeta!(QuantumToolbox, :DocTestSetup, :(using QuantumToolbox); recursive = true)
 
 # some options for `makedocs`
-const DRAFT = false  # set `true`  to disable cell evaluation
-const DOCTEST = true # set `false` to skip doc tests
+const DRAFT = true  # set `true`  to disable cell evaluation
+const DOCTEST = false # set `false` to skip doc tests
 
 # generate bibliography
 bib = CitationBibliography(

diff --git a/src/qobj/quantum_object_evo.jl b/src/qobj/quantum_object_evo.jl
@@ -1,3 +1,7 @@
+#=
+This file defines the QuantumObjectEvolution (QobjEvo) structure.
+=#
+
 export QuantumObjectEvolution
 
 @doc raw"""

diff --git a/src/qobj/synonyms.jl b/src/qobj/synonyms.jl
@@ -13,14 +13,14 @@ export sqrtm, logm, expm, sinm, cosm
 
 `Qobj` is a synonym for generating [`QuantumObject`](@ref). See the docstring of [`QuantumObject`](@ref) for more details.
 """
-Qobj(A; kwargs...) = QuantumObject(A; kwargs...)
+const Qobj = QuantumObject # we need the docstring here, otherwise the docstring won't be found because QuantumObject is not a public symbol
 
 @doc raw"""
     QobjEvo(args...; kwargs...)
 
 `QobjEvo` is a synonym for generating [`QuantumObjectEvolution`](@ref). See the docstrings of [`QuantumObjectEvolution`](@ref) for more details.
 """
-QobjEvo(args...; kwargs...) = QuantumObjectEvolution(args...; kwargs...)
+const QobjEvo = QuantumObjectEvolution # we need the docstring here, otherwise the docstring won't be found because QuantumObjectEvolution is not a public symbol
 
 const shape = size