phetsims / utterance-queue

Alerting library powered by aria-live
MIT License
0 stars 2 forks source link

Utterance terminology #27

Closed zepumph closed 2 years ago

zepumph commented 2 years ago

I have noticed a lot of indiscretion as it pertains to the terminology involved with Utterances. I would like to potentially set it straight, or at least get on the same page. Here are the words that I come in contact with quite often, and what I would like the definitions to be:

Ways in which the above differs from terminology in master, and potential ways this could adhere to the above if we want to adopt that:

@jessegreenberg the first question is do you think any work on this issue is worth while, even minor steps? The next question is about reviewing my proposal and going from there. Marking for meeting, but assigning for comment if async comes first.

Thanks again for the marathon meeting this afternoon. It really helped progress the work in UtteranceQueue!

zepumph commented 2 years ago

@jessegreenberg and I discussed today, and we note that there is discrepancy in how we use this terminology. That said we want to talk about it more next week after thinking about it for a week.

  • Utterance.alert. This could be renamed to Utterance.announcement

We are pretty sure that this would be an improvement.

See you next week!

zepumph commented 2 years ago

What about AlertManager? Does that mean it only can support description Utterances? (hopefully not!)

zepumph commented 2 years ago

Tagging https://github.com/phetsims/utterance-queue/issues/13

zepumph commented 2 years ago

This week, I was feeling like "alert" is a nice verb that should be able to be used for any Announcer.

@jessegreenberg doesn't feel too strongly about consistency, and also doesn't really like the above proposal. That said he doesn't have an alternative.

We feel ready to close this issue as a won't-fix.