Changeset 5782f99 for doc

Timestamp:

Mar 24, 2017, 7:46:40 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler

Children:

4e2173e

Parents:

67e0eeb

Message:

doc/develop.rst: improve examples

File:

• doc/develop.rst (modified) (3 diffs)

doc/develop.rst

@@ -86 +86 @@
 --------------------
 
-In this example, ``aubio_source`` is used to read a media file.
+In this example, `aubio_source <https://aubio.org/doc/latest/source_8h.html>`_
+is used to read a media file:
 
-First, create the objects we need.
+First, define a few variables and allocate some memory.
 
 .. literalinclude:: ../tests/src/io/test-source.c
@@ -104 +105 @@
    :lines: 40-44
 
-At the end of the processing loop, clean-up and de-allocate memory:
+At the end of the processing loop, memory is deallocated:
 
 .. literalinclude:: ../tests/src/io/test-source.c
    :language: C
-   :lines: 50-56
+   :lines: 55-56
 
 See the complete example: :download:`test-source.c
@@ -126 +127 @@
 .. literalinclude:: ../tests/src/spectral/test-phasevoc.c
    :language: C
-   :lines: 21-35
+   :lines: 20-37
+
+Time to clean up the previously allocated memory:
+
+.. literalinclude:: ../tests/src/spectral/test-phasevoc.c
+   :language: C
+   :lines: 39-44
 
 See the complete example: :download:`test-phasevoc.c