ref: 6d8ae981837b5923ca7d5d0ddf5ee2ec60fa9f31
parent: 37a6942ec0ea7176755e54dc4fb05206ed9a7374
author: Paul Brossier <piem@piem.org>
date: Tue Oct 30 12:52:52 EDT 2018
[py] improve py-cvec.c doc
--- a/python/ext/py-cvec.c
+++ b/python/ext/py-cvec.c
@@ -24,9 +24,10 @@
"\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"