Changeset 6d8ae981 for python/ext/py-cvec.c

Timestamp:

Oct 30, 2018, 4:52:52 PM (6 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master

Children:

78c1d32

Parents:

37a6942

Message:

[py] improve py-cvec.c doc

File:

• python/ext/py-cvec.c (modified) (1 diff)

python/ext/py-cvec.c

@@ -25 +25 @@
 "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"