Skip to content

Commit 7c0569c

Browse files
committed
Docstring update
1 parent 48ca157 commit 7c0569c

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

pysteps/utils/fft.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,22 @@
2020
scipy_fft.irfft2 = numpy_fft.irfft2
2121

2222
def get_method(name):
23-
"""Return a callable function for the FFT method corresponding to the given name."""
23+
"""Return a callable function for the FFT method corresponding to the given
24+
name.
25+
26+
Parameters
27+
----------
28+
name : str
29+
The name of the method. The available options are 'numpy', 'scipy' and
30+
'pyfftw'
31+
32+
Returns
33+
-------
34+
out : tuple
35+
A two-element tuple containing the FFT module and a dictionary of
36+
default keyword arguments for calling the FFT method. Each module
37+
implements the numpy.fft interface.
38+
"""
2439
if name == "numpy":
2540
return numpy_fft,{}
2641
elif name == "scipy":

0 commit comments

Comments
 (0)