shithub: aubio

--- a/python/ext/py-cvec.c

+++ b/python/ext/py-cvec.c

@@ -19,7 +19,36 @@

   uint_t length;

 } Py_cvec;

-static char Py_cvec_doc[] = "cvec object";

+static char Py_cvec_doc[] = ""

+"cvec(size)\n"

+"\n"

+"Data structure to hold spectral vectors.\n"

+"\n"

+"A vector holding spectral data in two vectors, :attr:`phas`\n"

+"and :attr:`norm`. Each vector is a :class:`numpy.ndarray`\n"

+"of shape `(length,)`, where `length = size // 2 + 1`.\n"

+"\n"

+"Parameters\n"

+"----------\n"

+"size: int\n"

+"   Size of spectrum to create.\n"

+"\n"

+"Examples\n"

+"--------\n"

+">>> c = aubio.cvec(1024)\n"

+">>> c\n"

+"aubio cvec of 513 elements\n"

+">>> c.length\n"

+"513\n"

+">>> c.norm.dtype, c.phas.dtype\n"

+"(dtype('float32'), dtype('float32'))\n"

+">>> c.norm.shape, c.phas.shape\n"

+"((513,), (513,))\n"

+"\n"

+"See Also\n"

+"--------\n"

+"fft, pvoc\n"

+"";

 PyObject *

@@ -182,7 +211,7 @@

 static PyMemberDef Py_cvec_members[] = {

   // TODO remove READONLY flag and define getter/setter

   {"length", T_INT, offsetof (Py_cvec, length), READONLY,

-      "length attribute"},

+      "int: Length of `norm` and `phas` vectors."},

   {NULL}                        /* Sentinel */

};

@@ -191,11 +220,11 @@

};

 static PyGetSetDef Py_cvec_getseters[] = {

-  {"norm", (getter)Py_cvec_get_norm, (setter)Py_cvec_set_norm,

-      "Numpy vector of shape (length,) containing the magnitude",

+  {"norm", (getter)Py_cvec_get_norm, (setter)Py_cvec_set_norm,

+      "numpy.ndarray: Vector of shape `(length,)` containing the magnitude.",

       NULL},

-  {"phas", (getter)Py_cvec_get_phas, (setter)Py_cvec_set_phas,

-      "Numpy vector of shape (length,) containing the phase",

+  {"phas", (getter)Py_cvec_get_phas, (setter)Py_cvec_set_phas,

+      "numpy.ndarray: Vector of shape `(length,)` containing the phase.",

       NULL},

   {NULL} /* sentinel */

};