History

[py] add basic module docstring

Paul Brossier committed 8 years ago

Commit 7cfad8e1 parent 78c1d321 file · +22 −0Browse files

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

Unified · Split

python/lib/aubio/__init__.py+22−0
@@ -1,4 +1,26 @@
11 #! /usr/bin/env python
2+# -*- coding: utf8 -*-
3+
4+"""
5+aubio
6+=====
7+
8+Provides a number of classes and functions for music and audio signal
9+analysis.
10+
11+How to use the documentation
12+----------------------------
13+
14+Documentation of the python module is available as docstrings provided
15+within the code, and a reference guide available online from `the
16+aubio homepage <https://aubio.org/documentation>`_.
17+
18+The docstrings examples are written assuming `aubio` and `numpy` have been
19+imported with:
20+
21+>>> import aubio
22+>>> import numpy as np
23+"""
224
325 import numpy
426 from ._aubio import __version__ as version

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