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

Documentation errors for FFTW module in genstdlib.jl #13285

Closed
jakebolewski opened this issue Sep 23, 2015 · 4 comments
Closed

Documentation errors for FFTW module in genstdlib.jl #13285

jakebolewski opened this issue Sep 23, 2015 · 4 comments
Labels
bug Indicates an unexpected problem or unintended behavior docsystem The documentation building system

Comments

@jakebolewski
Copy link
Member

As a follow up to #13274 now that #13281 is merged, the FFTW methods are not being documented correctly to be picked up by genstdlib.jl.

cc @nkottary

@jakebolewski jakebolewski added bug Indicates an unexpected problem or unintended behavior docsystem The documentation building system labels Sep 23, 2015
@tkelman
Copy link
Contributor

tkelman commented Sep 23, 2015

how do we fix it? I think I also saw a warning about a signature change in eigs

@MichaelHatherly
Copy link
Member

I was able to fix the major errors/warnings with this diff, https://gist.github.com/MichaelHatherly/b45a571854387a9700e9, but managed to introduce some weird character changes in the process... anyone seen those before?

The eigs signature had ended up out of sync, and I needed to add the DFT and FFTW modules to genstdlib.jl manually (see the add_all_docs_mod(...) calls) to get it to recognise the docstrings that got moved inline recently into those modules. Would be good to have that done automatically though.

Also, combining the ifftshift docstrings into a single one since before both the second docstring was just redocumenting the same Function rather than a particular Method.

@tkelman
Copy link
Contributor

tkelman commented Oct 4, 2015

Is this fixed?

@MichaelHatherly
Copy link
Member

With the rewrite of genstdlib.jl #15266 I've not noticed any problems with the FFTW module, so I'll close this for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or unintended behavior docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

3 participants