From: Thomas Fillon <thomas@parisson.com>
Date: Mon, 6 Jan 2014 12:44:46 +0000 (+0100)
Subject: LiveDecoder : Add doc + doctest example
X-Git-Tag: 0.5.3~29^2~5
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=9327d0fb822422925a6bc2609ae20596d4756213;p=timeside.git

LiveDecoder : Add doc + doctest example
---

diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst
index ac081a5..5f06ac1 100644
--- a/doc/source/api/decoder/index.rst
+++ b/doc/source/api/decoder/index.rst
@@ -24,3 +24,11 @@ Array Decoder
    :members:
    :undoc-members:
    :show-inheritance:
+
+Live Decoder
+=============
+
+.. autoclass:: LiveDecoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/timeside/core.py b/timeside/core.py
index 50f1f3b..f16a144 100644
--- a/timeside/core.py
+++ b/timeside/core.py
@@ -304,7 +304,6 @@ class ProcessPipe(object):
 
         def signal_handler(signum, frame):
             source.stop()
-            signal.signal(signum, signal.SIG_DFL)
 
         signal.signal(signal.SIGINT, signal_handler)
 
diff --git a/timeside/decoder/core.py b/timeside/decoder/core.py
index c86e134..719175a 100644
--- a/timeside/decoder/core.py
+++ b/timeside/decoder/core.py
@@ -432,8 +432,24 @@ class LiveDecoder(Decoder):
         ----------
         num_buffers :
             Number of buffers to output before sending EOS (-1 = unlimited).
-            Allowed values: >= -1
-            Default value: -1
+            (Allowed values: >= -1, Default value: -1)
+
+
+        Examples
+        --------
+
+        >>> import timeside
+
+        >>> live = timeside.decoder.LiveDecoder(num_buffers=25)
+        >>> a = timeside.analyzer.Waveform()
+        >>> e = timeside.encoder.Mp3Encoder('test_live.mp3', overwrite=True)
+        >>> pipe = (live | a | e)
+        >>> pipe.run()
+
+        >>> import matplotlib.pyplot as plt # doctest: +SKIP
+        >>> plt.plot(a.results['waveform_analyzer'].time, # doctest: +SKIP
+                 a.results['waveform_analyzer'].data) # doctest: +SKIP
+        >>> plt.show() # doctest: +SKIP
 
         """