History

[py] improve py-cvec.c doc

Paul Brossier committed 8 years ago

Commit 6d8ae981 parent 37a69421 file · +4 −3Browse files

Showing the changes to python/ext (1 of 1 file). Show all

Unified · Split

python/ext/py-cvec.c+4−3
@@ -24,9 +24,10 @@ static char Py_cvec_doc[] = "" · 23 unmodified lines
2424 "\n"
2525 "A container holding spectral data.\n"
2626 "\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"
27+"Create one `cvec` to store the spectral information of a window\n"
28+"of `size` points. The data will be stored in two vectors,\n"
29+":attr:`phas` and :attr:`norm`, each of shape (:attr:`length`,),\n"
30+"with `length = size // 2 + 1`.\n"
3031 "\n"
3132 "Parameters\n"
3233 "----------\n"

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t