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