`num_threads` not documented for `plan_fft!`
- Dominant language
- Julia
- Stars
- 300
- Forks
- 61
- PR merge metrics
- No merged PRs in 30d
Description
`plan_fft!` and friends have a useful option `num_threads` that does not appear to be documented. I suppose the documentation is at https://github.com/JuliaMath/AbstractFFTs.jl/blob/65b7fcb41cfe5ed9caf586c1330d0041fac9226d/src/definitions.jl#L102-L131, so I am not sure if this issue should be opened on this repo or AbstractFFTs.jl.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by inspecting AbstractFFTs.jl's src/definitions.jl around lines 102-131, then confirm whether FFTW.jl or AbstractFFTs.jl owns the documentation for plan_fft! and related functions. Document the num_threads option for those APIs in the appropriate repository, with completion marked by the option being visible in their documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100