Skip to content

Commit a70ff87

Browse files
authored
note region in README for devs
1 parent c05abee commit a70ff87

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To define a new FFT implementation in your own module, you should
2323
inverse plan.
2424

2525
* Define a new method `AbstractFFTs.plan_fft(x, region; kws...)` that returns a `MyPlan` for at least some types of
26-
`x` and some set of dimensions `region`.
26+
`x` and some set of dimensions `region`. The `region` (or a copy thereof) should be accessible via `region(p::MyPlan)` (which defaults to `p.region`).
2727

2828
* Define a method of `LinearAlgebra.mul!(y, p::MyPlan, x)` (or `A_mul_B!(y, p::MyPlan, x)` on Julia prior to
2929
0.7.0-DEV.3204) that computes the transform `p` of `x` and stores the result in `y`.

0 commit comments

Comments
 (0)