updated sonify module

jams/sonify.py

@@ -7,18 +7,16 @@
 .. autosummary::
     :toctree: generated/
 
-    beat
-    chord
-    melody
-    onset
-    segment
+    sonify
 '''
 
 import six
 import mir_eval.sonify
 from .eval import validate_annotation
 from .exceptions import NamespaceError
 
+__all__ = ['sonify']
+
 
 def clicks(annotation, sr=22050, duration=None, **kwargs):
     '''Sonify clicks timings
@@ -48,6 +46,30 @@ def chord(annotation, sr=22050, duration=None, **kwargs):
 
 def sonify(annotation, sr=22050, duration=None, **kwargs):
     '''Sonify a jams annotation through mir_eval
+
+    Parameters
+    ----------
+    annotation : jams.Annotation
+        The annotation to sonify
+
+    sr = : int > 0
+        The sampling rate of the output waveform
+
+    duration : float (optional)
+        Optional length (in seconds) of the output waveform
+
+    kwargs
+        Additional keyword arguments to mir_eval.sonify functions
+
+    Returns
+    -------
+    y_sonified : np.ndarray
+        The waveform of the sonified annotation
+
+    Raises
+    ------
+    NamespaceError
+        If the annotation has an un-sonifiable namespace
     '''
 
     # TODO: add pitch contour sonification here