JuliaLang / julia

The Julia Programming Language
https://julialang.org/
MIT License
45.68k stars 5.48k forks source link

genstdlib.jl doesn't understand fft doctring #12775

Closed jiahao closed 9 years ago

jiahao commented 9 years ago
Converting stdlib/

...
WARNING: Error converting docstring:

fft(A[, dims])


Performs a multidimensional FFT of the array `A`.  The optional `dims` argument specifies an iterable subset of dimensions (e.g. an integer, range, tuple, or array) to transform along.  Most efficient if the size of `A` along the transformed dimensions is a product of small primes; see `nextprod()`.  See also `plan_fft()` for even greater efficiency.

A one-dimensional FFT computes the one-dimensional discrete Fourier transform (DFT) as defined by

$\operatorname{DFT}(A)[k] =
  \sum_{n=1}^{\operatorname{length}(A)}
  \exp\left(-i\frac{2\pi
  (n-1)(k-1)}{\operatorname{length}(A)} \right) A[n].$
A multidimensional FFT simply performs this operation along each transformed dimension of `A`.

Higher performance is usually possible with multi-threading. Use `FFTW.set_num_threads(np)` to use `np` threads, if you have `np` processors.
INFO: no docs for Base.fft
ViralBShah commented 9 years ago

Just noting that this should not be an RC blocker.

jiahao commented 9 years ago

I thought we wanted a lossless doc transition....?

tknopp commented 9 years ago

@jiahao is IMHO right. RC is that thing that could be final. Prior to that it is a beta.

tkelman commented 9 years ago

We have lots of still-unresolved doc cleanups. ifft's math block, utf32 and several Dates module clashes, @sprintf, and readdlm are just the ones I saw on the conversion PR's.