improve docstring for synonyms

Author: ytdHuang

src/qobj/arithmetic_and_attributes.jl

@@ -112,13 +112,15 @@ LinearAlgebra.:(/)(A::AbstractQuantumObject{DT}, n::T) where {DT,T<:Number} =
     get_typename_wrapper(A)(A.data / n, A.type, A.dims)
 
 @doc raw"""
+    A ⋅ B
     dot(A::QuantumObject, B::QuantumObject)
 
 Compute the dot product between two [`QuantumObject`](@ref): ``\langle A | B \rangle``
 
 Note that `A` and `B` should be [`Ket`](@ref) or [`OperatorKet`](@ref)
 
-`A ⋅ B` (where `⋅` can be typed by tab-completing `\cdot` in the REPL) is a synonym for `dot(A, B)`
+!!! note
+    `A ⋅ B` (where `⋅` can be typed by tab-completing `\cdot` in the REPL) is a synonym of `dot(A, B)`.
 """
 function LinearAlgebra.dot(
     A::QuantumObject{DT1,OpType},
@@ -138,7 +140,8 @@ Supports the following inputs:
 - `A` is in the type of [`Operator`](@ref), with `i` and `j` are both [`Ket`](@ref).
 - `A` is in the type of [`SuperOperator`](@ref), with `i` and `j` are both [`OperatorKet`](@ref)
 
-Note that `matrix_element(i, A, j)` is a synonym of `dot(i, A, j)`.
+!!! note
+    `matrix_element(i, A, j)` is a synonym of `dot(i, A, j)`.
 """
 function LinearAlgebra.dot(
     i::QuantumObject{DT1,KetQuantumObject},
@@ -202,7 +205,8 @@ LinearAlgebra.transpose(
 
 Lazy adjoint (conjugate transposition) of the [`AbstractQuantumObject`](@ref)
 
-Note that `A'` and `dag(A)` are synonyms of `adjoint(A)`.
+!!! note
+    `A'` and `dag(A)` are synonyms of `adjoint(A)`.
 """
 LinearAlgebra.adjoint(
     A::AbstractQuantumObject{DT,OpType},
@@ -322,7 +326,8 @@ Support for the following types of [`QuantumObject`](@ref):
 - If `A` is [`Ket`](@ref) or [`Bra`](@ref), default `p = 2`
 - If `A` is [`Operator`](@ref), default `p = 1`
 
-Note that `unit` is a synonym of `normalize`.
+!!! note
+    `unit` is a synonym of `normalize`.
 
 Also, see [`norm`](@ref) about its definition for different types of [`QuantumObject`](@ref).
 """
@@ -382,7 +387,8 @@ LinearAlgebra.rmul!(B::QuantumObject{<:AbstractArray}, a::Number) = (rmul!(B.dat
 
 Matrix square root of [`QuantumObject`](@ref)
 
-Note that `√(A)` is a synonym for `sqrt(A)`
+!!! note
+    `√(A)` (where `√` can be typed by tab-completing `\sqrt` in the REPL) is a synonym of `sqrt(A)`.
 """
 LinearAlgebra.sqrt(A::QuantumObject{<:AbstractArray{T}}) where {T} =
     QuantumObject(sqrt(sparse_to_dense(A.data)), A.type, A.dims)

src/qobj/boolean_functions.jl

@@ -65,7 +65,8 @@ issuper(A) = false # default case
 
 Test whether the [`AbstractQuantumObject`](@ref) is Hermitian.
 
-Note that `isherm` is a synonym of `ishermitian`.
+!!! note
+    `isherm` is a synonym of `ishermitian`.
 """
 LinearAlgebra.ishermitian(A::AbstractQuantumObject) = ishermitian(A.data)
 

src/qobj/functions.jl

@@ -154,7 +154,8 @@ end
 
 Returns the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product) ``\hat{A} \otimes \hat{B} \otimes \cdots``.
 
-Note that `tensor` and `⊗` are synonyms of `kron`.
+!!! note
+    `tensor` and `⊗` (where `⊗` can be typed by tab-completing `\otimes` in the REPL) are synonyms of `kron`.
 
 # Examples
 

src/qobj/operators.jl

@@ -422,9 +422,10 @@ Identity operator ``\hat{\mathbb{1}}`` with size `N`.
 
 It is also possible to specify the list of Hilbert dimensions `dims` if different subsystems are present.
 
-Note that 
-- `type` can only be either [`Operator`](@ref) or [`SuperOperator`](@ref)
-- `qeye` is a synonym of `eye`
+Note that `type` can only be either [`Operator`](@ref) or [`SuperOperator`](@ref)
+
+!!! note
+    `qeye` is a synonym of `eye`.
 """
 eye(
     N::Int;

src/qobj/quantum_object.jl

@@ -59,7 +59,8 @@ QuantumObject(A::AbstractArray, type::ObjType, dims::Integer) where {ObjType<:Qu
 
 Generate [`QuantumObject`](@ref) with a given `A::AbstractArray` and specified `type::QuantumObjectType` and `dims`.
 
-Note that `Qobj` is a synonym of `QuantumObject`.
+!!! note
+    `Qobj` is a synonym of `QuantumObject`.
 """
 function QuantumObject(
     A::AbstractMatrix{T};

src/qobj/quantum_object_base.jl

@@ -128,7 +128,8 @@ Returns a tuple containing each dimensions of the array in the [`AbstractQuantum
 
 Optionally, you can specify an index (`idx`) to just get the corresponding dimension of the array.
 
-Note that `shape` is a synonym of `size`.
+!!! note
+    `shape` is a synonym of `size`.
 """
 Base.size(A::AbstractQuantumObject) = size(A.data)
 Base.size(A::AbstractQuantumObject, idx::Int) = size(A.data, idx)

src/qobj/quantum_object_evo.jl

@@ -181,9 +181,10 @@ Generate [`QuantumObjectEvolution`](@ref).
 !!! warning "Beware of type-stability!"
     Please note that, unlike QuTiP, this function doesn't support `op_func_list` as `Vector` type. This is related to the type-stability issue. See the Section [The Importance of Type-Stability](@ref doc:Type-Stability) for more details.
 
-# Notes
-- If `α` is provided, all the operators in `op_func_list` will be pre-multiplied by `α`. The `type` parameter is used to specify the type of the [`QuantumObject`](@ref), either `Operator` or `SuperOperator`. The `f` parameter is used to pre-apply a function to the operators before converting them to SciML operators.
-- `QobjEvo` is a synonym of `QuantumObjectEvolution`
+Note that if `α` is provided, all the operators in `op_func_list` will be pre-multiplied by `α`. The `type` parameter is used to specify the type of the [`QuantumObject`](@ref), either `Operator` or `SuperOperator`. The `f` parameter is used to pre-apply a function to the operators before converting them to SciML operators.
+
+!!! note
+    `QobjEvo` is a synonym of `QuantumObjectEvolution`.
 
 # Examples
 This operator can be initialized in the same way as the QuTiP `QobjEvo` object. For example

src/qobj/synonyms.jl

@@ -11,14 +11,16 @@ export sqrtm, logm, expm, sinm, cosm
 @doc raw"""
     Qobj(A; kwargs...)
 
-`Qobj` is a synonym for generating [`QuantumObject`](@ref). See the docstring of [`QuantumObject`](@ref) for more details.
+!!! note
+    `Qobj` is a synonym for generating [`QuantumObject`](@ref). See the docstring of [`QuantumObject`](@ref) for more details.
 """
 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.
+!!! note
+    `QobjEvo` is a synonym for generating [`QuantumObjectEvolution`](@ref). See the docstrings of [`QuantumObjectEvolution`](@ref) for more details.
 """
 const QobjEvo = QuantumObjectEvolution # we need the docstring here, otherwise the docstring won't be found because QuantumObjectEvolution is not a public symbol