[py] improve py-cvec.c doc
authorPaul Brossier <piem@piem.org>
Tue, 30 Oct 2018 15:30:33 +0000 (16:30 +0100)
committerPaul Brossier <piem@piem.org>
Tue, 30 Oct 2018 15:30:33 +0000 (16:30 +0100)
python/ext/py-cvec.c

index 1426c0e..4d0c1d8 100644 (file)
@@ -22,11 +22,11 @@ typedef struct
 static char Py_cvec_doc[] = ""
 "cvec(size)\n"
 "\n"
-"Data structure to hold spectral vectors.\n"
+"A container holding spectral data.\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"
+"A vector storing spectral information of one time window\n"
+"in two vectors, :attr:`phas` and :attr:`norm`, each of shape\n"
+"(:attr:`length`,), with `length = size // 2 + 1`.\n"
 "\n"
 "Parameters\n"
 "----------\n"
@@ -47,7 +47,7 @@ static char Py_cvec_doc[] = ""
 "\n"
 "See Also\n"
 "--------\n"
-"fft, pvoc\n"
+"fvec, fft, pvoc\n"
 "";