Changeset 37a6942


Ignore:
Timestamp:
Oct 30, 2018, 4:30:33 PM (13 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
6d8ae981
Parents:
8986239
Message:

[py] improve py-cvec.c doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/ext/py-cvec.c

    r8986239 r37a6942  
    2323"cvec(size)\n"
    2424"\n"
    25 "Data structure to hold spectral vectors.\n"
    26 "\n"
    27 "A vector holding spectral data in two vectors, :attr:`phas`\n"
    28 "and :attr:`norm`. Each vector is a :class:`numpy.ndarray`\n"
    29 "of shape `(length,)`, where `length = size // 2 + 1`.\n"
     25"A container holding spectral data.\n"
     26"\n"
     27"A vector storing spectral information of one time window\n"
     28"in two vectors, :attr:`phas` and :attr:`norm`, each of shape\n"
     29"(:attr:`length`,), with `length = size // 2 + 1`.\n"
    3030"\n"
    3131"Parameters\n"
     
    4848"See Also\n"
    4949"--------\n"
    50 "fft, pvoc\n"
     50"fvec, fft, pvoc\n"
    5151"";
    5252
Note: See TracChangeset for help on using the changeset viewer.