Skip to content

Commit 2b90223

Browse files
committed
fix(docs): Add set_provider! to the documentation
1 parent 3db17a2 commit 2b90223

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

docs/src/fft.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ FFTW.plan_dct
2020
FFTW.plan_idct
2121
FFTW.plan_dct!
2222
FFTW.plan_idct!
23+
FFTW.set_provider!
2324
```

docs/src/index.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,10 @@ Pkg.add("FFTW")
1515

1616
from the Julia REPL.
1717

18-
Users with a build of Julia based on Intel's Math Kernel Library (MKL) can use MKL
19-
for FFTs by setting a preference in their top-level project by either using the
20-
`FFTW.set_provider!()` method, or by directly setting the preference using
21-
[`Preferences.jl`](https://github.com/JuliaPackaging/Preferences.jl). Note that this
22-
choice will be recorded for the current project, and other projects that wish to use
23-
MKL for FFTs should also set that same preference.
24-
Note further that MKL provides only a subset of the functionality provided by FFTW. See
25-
Intel's [documentation](https://software.intel.com/en-us/mkl-developer-reference-c-using-fftw3-wrappers)
26-
for more information about potential differences or gaps in functionality.
18+
Users with a build of Julia based on Intel's Math Kernel Library (MKL) can use MKL for FFTs by setting a preference in
19+
their top-level project by either using the [`FFTW.set_provider!()`](@ref) method, or by directly setting the preference
20+
using [`Preferences.jl`](https://github.com/JuliaPackaging/Preferences.jl). Note that this choice will be recorded for
21+
the current project, and other projects that wish to use MKL for FFTs should also set that same preference. Note further
22+
that MKL provides only a subset of the functionality provided by FFTW. See Intel's
23+
[documentation](https://software.intel.com/en-us/mkl-developer-reference-c-using-fftw3-wrappers) for more information
24+
about potential differences or gaps in functionality.

0 commit comments

Comments
 (0)