document why Property<SpeechSynthesisVoice | null> will not be PhET-i…

…O instrumented, #22
phetsims · Dec 12, 2024 · 45e8085 · 45e8085
1 parent a64e61c
commit 45e8085
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/js/common/model/NumberPairsPreferences.ts b/js/common/model/NumberPairsPreferences.ts
@@ -33,10 +33,10 @@ const NumberPairsPreferences = {
   // Second locale
   secondLocaleProperty: secondLocaleProperty,
 
-  // Voice for the primary locale
+  // Voices for the primary and second locale. At 12/12/24 PhET-iO meeting, we decided that these Properties will
+  // not be instrumented for PhET-iO. SpeechSynthesisVoice is a native JavaScript type, so creating an IOType is
+  // problematic. And it doesn’t make sense to configure in a wrapper, because available voices are platform specific.
   primaryVoiceProperty: new Property<SpeechSynthesisVoice | null>( null ),
-
-  // Voice for the second locale
   secondVoiceProperty: new Property<SpeechSynthesisVoice | null>( null ),
 
   // When true, the phrase will automatically be spoken whenever it changes.