]> git.parisson.com Git - timeside.git/commitdiff
fix doc
authorGuillaume Pellerin <yomguy@parisson.com>
Thu, 29 Jan 2015 12:08:11 +0000 (13:08 +0100)
committerGuillaume Pellerin <yomguy@parisson.com>
Thu, 29 Jan 2015 12:08:11 +0000 (13:08 +0100)
README.rst
doc/source/intro.rst
doc/source/news.rst

index 92b944ab03fd95f8d4c181a8a4614e9f4e03ad51..a8fc4abe7645da6f186a14db3b3d95066ef65432 100644 (file)
@@ -61,15 +61,9 @@ Dive in
 To list all available plugins::
 
 
-   import os
-   os.remove('sweep.ogg')
-   os.remove('waveform.png')
-
-
    >>> import timeside.core
    >>> timeside.core.list_processors()
 
-
 Define some processors::
 
 
@@ -114,7 +108,7 @@ News
  * Code refactoring:
 
    - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decoder,analyzer, timeside.plugins.encoder, timeside.plugins.fx
-   - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`.
+   - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`
    - `timeside.plugins` is now a `namespace package <https://pythonhosted.org/setuptools/setuptools.html#namespace-packages>`_ enabling external plugins to be **automatically** plugged into TimeSide (see for example `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_). This now makes TimeSide a **real** plugin host, yeah!
    - A dummy timeside plugin will soon be provided for easy development start.
 
index 6e9393c4ef94d2a6b6687d13d17ebb5d8bb08369..0417bc248bdf68e0538b74299eefc5194336dc4d 100644 (file)
@@ -60,18 +60,11 @@ Dive in
 
 To list all available plugins::
 
-.. testcleanup::
-
-   import os
-   os.remove('sweep.ogg')
-   os.remove('waveform.png')
-
 .. doctest::
 
    >>> import timeside.core
    >>> timeside.core.list_processors()
 
-
 Define some processors::
 
 .. doctest::
index 583e38b1f72edcc1c0fa70f6d32d48773a49f8dc..d1da3a493efe566d1baec60444da39c9a3759424 100644 (file)
@@ -10,7 +10,7 @@ News
  * Code refactoring:
 
    - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decoder,analyzer, timeside.plugins.encoder, timeside.plugins.fx
-   - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`.
+   - WARNING: to properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`
    - `timeside.plugins` is now a `namespace package <https://pythonhosted.org/setuptools/setuptools.html#namespace-packages>`_ enabling external plugins to be **automatically** plugged into TimeSide (see for example `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_). This now makes TimeSide a **real** plugin host, yeah!
    - A dummy timeside plugin will soon be provided for easy development start.