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

index 4d0c1d8..9854b6d 100644 (file)
@@ -24,9 +24,10 @@ static char Py_cvec_doc[] = ""
 "\n"
 "A container holding spectral data.\n"
 "\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"
+"Create one `cvec` to store the spectral information of a window\n"
+"of `size` points. The data will be stored  in two vectors,\n"
+":attr:`phas` and :attr:`norm`, each of shape (:attr:`length`,),\n"
+"with `length = size // 2 + 1`.\n"
 "\n"
 "Parameters\n"
 "----------\n"