[py] add a note about missing last timestamp to slice_source_at_stamps docs

Paul Brossier committed 8 years ago

Commit 97a8bef1 parent 5c6a8581 file · +7 −1Browse files

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

Unified · Split

     The default `samplerate` is 0, meaning the original sampling rate
     of `source_file` will be used. When using a sampling rate
     different to the one of the original files, `timestamps` and
-    `timestamps_end` should be expressed in re-sampled samples.
+    `timestamps_end` should be expressed in the re-sampled signal.
     The `hopsize` parameter simply tells :class:`source` to use this
     hopsize and does not change the output slices.
     Create one slice, from 1 second to 2 seconds:
     >>> aubio.slice_source_at_stamps('loop.wav', [44100], [44100*2])
+    Notes
+    -----
+    Slices may be overlapping. If `timestamps_end` is `1` element
+    shorter than `timestamps`, the last slice will end at the end of
+    the file.
     """
     if timestamps is None or len(timestamps) == 0:

Keyboard shortcuts