documentation for radiationRedirectionUtterance, see #192

phetsims · Aug 3, 2022 · 27ea84e · 27ea84e
1 parent 102839a
commit 27ea84e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/js/common/view/GasConcentrationAlerter.ts b/js/common/view/GasConcentrationAlerter.ts
@@ -80,6 +80,9 @@ class GasConcentrationAlerter extends Alerter {
   private netEnergyProperty: IReadOnlyProperty<number>;
   private previousNetInflowOfEnergy: number;
 
+  // An Utterance for the alert that describes radiation redirection from sky back to earth. It is announced after
+  // a change in concentration. It is assertive because we want this initial change to interrupt any stale alerts
+  // after the change in concentration.
   private readonly radiationRedirectionUtterance = new Utterance( {
     announcerOptions: {
       ariaLivePriority: AriaLiveAnnouncer.AriaLive.ASSERTIVE