History

[py] add minimal docstring to fft

Paul Brossier committed 7 years ago

Commit e14f7a71 parent f19db541 file · +19 −1Browse files

Showing the changes to python/ext (1 of 1 file). Show all

Unified · Split

python/ext/py-fft.c+19−1
@@ -1,6 +1,24 @@
11 #include "aubio-types.h"
22
3−static char Py_fft_doc[] = "fft object";
3+static char Py_fft_doc[] = ""
4+"fft(size=1024)\n"
5+"\n"
6+"Compute Fast Fourier Transorms.\n"
7+"\n"
8+"Parameters\n"
9+"----------\n"
10+"size : int\n"
11+" size of the FFT to compute\n"
12+"\n"
13+"Example\n"
14+"-------\n"
15+">>> x = aubio.fvec(512)\n"
16+">>> f = aubio.fft(512)\n"
17+">>> c = f(x); c\n"
18+"aubio cvec of 257 elements\n"
19+">>> x2 = f.rdo(c); x2.shape\n"
20+"(512,)\n"
21+"";
422
523 typedef struct
624 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t