phetsims / joist

Joist is the main framework for PhET Interactive Simulations. Joist creates and displays the simulation content, home screen, navigation bar, About dialog, enables switching between tabs, and other framework-related features.
MIT License
8 stars 6 forks source link

Rename `PreferencesModel.supportsMultipleLocales` to `PreferencesModel.supportsDynamicLocales` #891

Closed jessegreenberg closed 1 year ago

jessegreenberg commented 1 year ago

This option of PreferencesModel lets you disable the feature even when the localeProperty indicates that multiple locales are available. Our project calls this feature "dynamic locales" so we should rename it in PreferencesModel.

jessegreenberg commented 1 year ago

OK @marlitas can you please confirm this is OK with you, and spot check? Feel free to close if all is well.

marlitas commented 1 year ago

I looked for supportsMultipleLocales in the project and noticed it is still being used for PreferencesModelIO, and is also in many phet-io-api files. Do we want to update this for the phet-io-api as well or does that involve too much complexity for a name change?

marlitas commented 1 year ago

Talked this through with @samreid and he mentioned that phet-io is in it's early stages, so updating the api for name changes such as these is encouraged. We went ahead and did that! @jessegreenberg can you take a look and close if all is well?

jessegreenberg commented 1 year ago

Awesome, thanks for updating these and for regenerating the PhET-iO APIs. I should have done that. Closing.