Skip to content

fix typos in doc strings #495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2025
Merged

fix typos in doc strings #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/qobj/synonyms.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const trans = transpose
const dag = adjoint

@doc raw"""
matrix_element(i::QuantumObject, A::QuantumObject j::QuantumObject)
matrix_element(i::QuantumObject, A::QuantumObject, j::QuantumObject)

Compute the generalized dot product `dot(i, A*j)` between three [`QuantumObject`](@ref): ``\langle i | \hat{A} | j \rangle``

Expand All @@ -61,7 +61,7 @@ const operator_to_vector = mat2vec

Matrix square root of [`Operator`](@ref) type of [`QuantumObject`](@ref)

Note that for other types of [`QuantumObject`](@ref) use `sprt(A)` instead.
Note that for other types of [`QuantumObject`](@ref) use `sqrt(A)` instead.
"""
sqrtm(A::QuantumObject{Operator}) = sqrt(A)

Expand Down
2 changes: 1 addition & 1 deletion src/time_evolution/time_evolution.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A Julia constructor for handling the `ODEProblem` of the time evolution of quant
# Fields (Attributes)

- `prob::AbstractSciMLProblem`: The `ODEProblem` of the time evolution.
- `times::Abstractvector`: The time list of the evolution.
- `times::AbstractVector`: The time list of the evolution.
- `dimensions::AbstractDimensions`: The dimensions of the Hilbert space.
- `kwargs::KWT`: Generic keyword arguments.

Expand Down
Loading