From d9b1d2ccc8e7a27c8b88be58153f7ae5309041c2 Mon Sep 17 00:00:00 2001
From: Paul Davis <paul@linuxaudiosystems.com>
Date: Wed, 17 Nov 2021 10:48:06 -0700
Subject: [PATCH] temporal: NOOP add helpful comment about bar_mod argument

---
 libs/temporal/tempo.cc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/libs/temporal/tempo.cc b/libs/temporal/tempo.cc
index 8fae2d6c35..48976cc947 100644
--- a/libs/temporal/tempo.cc
+++ b/libs/temporal/tempo.cc
@@ -1803,6 +1803,12 @@ TempoMap::_get_tempo_and_meter (typename const_traits_t::tempo_point_type & tp,
 void
 TempoMap::get_grid (TempoMapPoints& ret, superclock_t start, superclock_t end, uint32_t bar_mod)
 {
+	/* note: @param bar_mod is "bar modulo", and describes the N in "give
+	   me every Nth bar". If the caller wants every 4th bar, bar_mod ==
+	   4. If we want every point defined by the tempo note type (e.g. every
+	   quarter not, then bar_mod is zero.
+	*/
+
 	assert (!_tempos.empty());
 	assert (!_meters.empty());
 	assert (!_points.empty());