Changeset 37a6942

Timestamp:

Oct 30, 2018, 4:30:33 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:

6d8ae981

Parents:

8986239

Message:

[py] improve py-cvec.c doc

File:

• python/ext/py-cvec.c (modified) (2 diffs)

python/ext/py-cvec.c

@@ -23 +23 @@
 "cvec(size)\n"
 "\n"
-"Data structure to hold spectral vectors.\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 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"
 "\n"
 "Parameters\n"
@@ -48 +48 @@
 "See Also\n"
 "--------\n"
-"fft, pvoc\n"
+"fvec, fft, pvoc\n"
 "";