From 6d8ae981837b5923ca7d5d0ddf5ee2ec60fa9f31 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Tue, 30 Oct 2018 16:52:52 +0100 Subject: [PATCH] [py] improve py-cvec.c doc --- python/ext/py-cvec.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/python/ext/py-cvec.c b/python/ext/py-cvec.c index 4d0c1d81..9854b6d6 100644 --- a/python/ext/py-cvec.c +++ b/python/ext/py-cvec.c @@ -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" -- 2.11.0