DOC: add parameters, returns, examples to rfftfreq(), and format variables. #321

Closed
wants to merge 3 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

endolith commented Sep 21, 2012

Also STY: spaces around operators

Contributor

endolith commented Sep 21, 2012

adapted from numpy fftfreq()

+ ----------
+ n : int
+ Window length.
+ d : scalar
@rgommers

rgommers Sep 22, 2012

Owner

Should be scalar, optional.

scipy/fftpack/helper.py
+ Examples
+ --------
+ >>> sig = np.array([-2, 8, 6, 4, 1, 0, 3, 5], dtype=float)
+ >>> fourier = scipy.fftpack.rfft(sig)
@rgommers

rgommers Sep 22, 2012

Owner

from scipy import fftpack
fourier = fftpack.rfft(sig)

@rgommers

rgommers Sep 22, 2012

Owner

How about naming this sig_fft instead of fourier?

scipy/fftpack/helper.py
+ >>> fourier = scipy.fftpack.rfft(sig)
+ >>> n = fourier.size
+ >>> timestep = 0.1
+ >>> freq = scipy.fftpack.rfftfreq(n, d=timestep)
@rgommers

rgommers Sep 22, 2012

Owner

no `scipy.``

Owner

rgommers commented Oct 10, 2012

Merged in 217067d, thanks @endolith

@rgommers rgommers closed this Oct 10, 2012

@endolith endolith deleted the endolith:patch-11 branch May 5, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment