From e14f7a7de45cc4834ca07e7d424ef64f9b091e6f Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Mon, 3 Dec 2018 16:12:51 +0100 Subject: [PATCH] [py] add minimal docstring to fft --- python/ext/py-fft.c | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) 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 { -- 2.11.0