Mercurial > hg > svcore

diff base/EventSeries.h @ 1619:f594fd249473 single-point

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Further tests
author Chris Cannam
date Fri, 08 Mar 2019 12:59:32 +0000
parents ba3ddb7fe2bd
children dcd510bd89db
line wrap: on
line diff
--- a/base/EventSeries.h	Fri Mar 08 11:54:35 2019 +0000
+++ b/base/EventSeries.h	Fri Mar 08 12:59:32 2019 +0000
@@ -197,10 +197,11 @@
      * is less than f + d and its start frame plus its duration is
      * greater than f.
      * 
-     * Note that getEventsSpanning(f, 0) is not equivalent to
-     * getEventsCovering(f). The latter includes durationless events
-     * at f and events starting at f, both of which are excluded from
-     * the former.
+     * Note: Passing a duration of zero is seldom useful here; you
+     * probably want getEventsCovering instead. getEventsSpanning(f,
+     * 0) is not equivalent to getEventsCovering(f). The latter
+     * includes durationless events at f and events starting at f,
+     * both of which are excluded from the former.
      */
     EventVector getEventsSpanning(sv_frame_t frame,
                                   sv_frame_t duration) const {