Skip to content

Commit 552d49f

Browse files
committed
tweak adjoint doc string
1 parent 3ed83df commit 552d49f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/definitions.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,12 +600,15 @@ mutable struct AdjointPlan{T,P<:Plan} <: Plan{T}
600600
end
601601

602602
"""
603+
p'
603604
adjoint(p::Plan)
604605
605-
Form the adjoint operator of an FFT plan. Returns a plan `p'` which performs the adjoint operation
606+
Form the adjoint operator of an FFT plan. Returns a plan which performs the adjoint operation
606607
the original plan. Note that this differs from the corresponding backwards plan in the case of real
607608
FFTs due to the halving of one of the dimensions of the FFT output, as described in [`rfft`](@ref).
608-
Adjoint plans do not currently support `mul!`.
609+
610+
!!! note
611+
Adjoint plans do not currently support `LinearAlgebra.mul!`.
609612
"""
610613
Base.adjoint(p::Plan{T}) where {T} = AdjointPlan{T, typeof(p)}(p)
611614
Base.adjoint(p::AdjointPlan) = p.p

0 commit comments

Comments
 (0)