better docs for numberOfMiddleThresholds, see phetsims/geometric-opti…

…cs#259 (comment)
phetsims · Mar 7, 2022 · 139921d · 139921d
1 parent fa37998
commit 139921d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/js/sound-generators/ValueChangeSoundGenerator.ts b/js/sound-generators/ValueChangeSoundGenerator.ts
@@ -26,7 +26,8 @@ type SelfOptions = {
   // The sound player that will potentially be played when changes occur that are not to the min or max values.
   middleMovementSoundPlayer?: ISoundPlayer;
 
-  // The number of thresholds where the sound will be played during mouse- or touch-based dragging.
+  // The number of thresholds that, when reached or crossed, will cause a sound to be played when checking value changes
+  // against thresholds.  In other words, this is the number of thresholds that exist between the min and max values.
   numberOfMiddleThresholds?: number;
 
   // This function is used to constrain the threshold values that are used to decide when to play