Skip to content

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

@tomchor

Description

@tomchor

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions