Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

genstdlib.jl doesn't understand fft doctring #12775

Closed
jiahao opened this issue Aug 24, 2015 · 4 comments
Closed

genstdlib.jl doesn't understand fft doctring #12775

jiahao opened this issue Aug 24, 2015 · 4 comments
Labels
docsystem The documentation building system
Milestone

Comments

@jiahao
Copy link
Member

jiahao commented Aug 24, 2015

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
@jiahao jiahao added the docsystem The documentation building system label Aug 24, 2015
@jiahao jiahao added this to the 0.4.0 milestone Aug 24, 2015
@ViralBShah
Copy link
Member

Just noting that this should not be an RC blocker.

@jiahao
Copy link
Member Author

jiahao commented Aug 24, 2015

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

@tknopp
Copy link
Contributor

tknopp commented Aug 24, 2015

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

@tkelman
Copy link
Contributor

tkelman commented Aug 24, 2015

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.

carnaval added a commit that referenced this issue Aug 29, 2015
carnaval added a commit that referenced this issue Sep 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

4 participants