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

Doc examples use xrft.dft even though it's deprecated #199

Open
tomchor opened this issue May 30, 2023 · 1 comment
Open

Doc examples use xrft.dft even though it's deprecated #199

tomchor opened this issue May 30, 2023 · 1 comment

Comments

@tomchor
Copy link

tomchor commented May 30, 2023

Hi, everyone, I noticed all 4 doc examples use xrft.dft for the forward fft, but when I try to get info on the function the docstring claims it's deprecated:

In [22]: xrft.dft?
Signature: xrft.dft(da, dim=None, true_phase=False, true_amplitude=False, **kwargs)
Docstring: Deprecated function. See fft doc
File:      ~/miniconda3/envs/py310/lib/python3.10/site-packages/xrft/xrft.py
Type:      function

All the snippets I tried worked the same when swapping xrft.dft for xrft.fft, so I guess that's the new function to use? I figure it'd be best to open an issue first to make sure, before opening a PR to fix this.

I'm using version 1.0.1 btw.

@roxyboy
Copy link
Member

roxyboy commented Jun 1, 2023

Yes, the documentation examples are a bit out of date... xrft.fft is the up-to-date function to use. xrft.dft and xrft.fft have different default input arguments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants