From: Paul Brossier <piem@piem.org>
Date: Mon, 3 Dec 2018 15:12:51 +0000 (+0100)
Subject: [py] add minimal docstring to fft
X-Git-Tag: 0.4.9~134
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=e14f7a7de45cc4834ca07e7d424ef64f9b091e6f;p=aubio.git

[py] add minimal docstring to fft
---

diff --git a/python/ext/py-fft.c b/python/ext/py-fft.c
index 87636327..a08af4e7 100644
--- a/python/ext/py-fft.c
+++ b/python/ext/py-fft.c
@@ -1,6 +1,24 @@
 #include "aubio-types.h"
 
-static char Py_fft_doc[] = "fft object";
+static char Py_fft_doc[] = ""
+"fft(size=1024)\n"
+"\n"
+"Compute Fast Fourier Transorms.\n"
+"\n"
+"Parameters\n"
+"----------\n"
+"size : int\n"
+"    size of the FFT to compute\n"
+"\n"
+"Example\n"
+"-------\n"
+">>> x = aubio.fvec(512)\n"
+">>> f = aubio.fft(512)\n"
+">>> c = f(x); c\n"
+"aubio cvec of 257 elements\n"
+">>> x2 = f.rdo(c); x2.shape\n"
+"(512,)\n"
+"";
 
 typedef struct
 {