Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize the tandem hierarchy under "preferencesPanels" #961

Open
2 of 16 tasks
pixelzoom opened this issue Apr 9, 2024 · 1 comment
Open
2 of 16 tasks

Standardize the tandem hierarchy under "preferencesPanels" #961

pixelzoom opened this issue Apr 9, 2024 · 1 comment
Assignees

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Apr 9, 2024

Over in phetsims/projectile-data-lab#30 (comment), these phetioID simplifications were made:

  • preferencesPanels.simulationPreferencesPanel.simPreferences => preferencesPanels.simulationPreferencesPanel
  • preferencesPanels.audioPreferencesPanel.audioPreferences => preferencesPanels.audioPreferencesPanel

... for 2 reasons:
(1) This approach of adding an intermediate tandem was inconsistent with the Studio tree structure for other Panels.
(2) 'simPreferences' and 'audioPreferences' were duplicated in sim code.

Going forward, sims should use this new convention. PDL, FEL, and the gas-properties suite have already been modified, since PhET-iO versions have not been published yet.

PDL was the only sim using "audioPreferences".

The following sims have NOT been published with PhET-iO, and have "simPreferences" in their phet-io-api.json file. They should be changed ASAP, before they need a migration processor:

  • buoyancy
  • circuit-construction-kit-ac

The following sims HAVE been published with PhET-iO, and have "simPreferences" in their phet-io-api.json file. They will required a (shared?) migration processor, and testing in the Migration wrapper. Publishing an MR for these sims is not recommended (or feasible?) because this is an API change.

  • acid-base-solutions
  • beers-law-lab
  • build-an-atom
  • center-and-variability
  • circuit-construction-kit-dc
  • circuit-construction-kit-dc-virtual-lab
  • concentration
  • density
  • geometric-optics
  • geometric-optics-basics
  • greenhouse-effect
  • keplers-laws
  • molecule-polarity
  • molecule-shapes

Recommended to do all of the above sims at once -- probably 3-5 hours. Doing them one at a time as they are republished will likely double the cost.

Assigning to @brent-phet to schedule and prioritize.

@arouinfar @kathy-phet @samreid @matthew-blackman FYI.

@zepumph
Copy link
Member

zepumph commented Apr 11, 2024

We can make simPreferences bad text with lint after this work.

zepumph added a commit to phetsims/buoyancy-basics that referenced this issue Jun 7, 2024
zepumph added a commit to phetsims/buoyancy that referenced this issue Jun 7, 2024
zepumph added a commit to phetsims/density that referenced this issue Jun 7, 2024
zepumph added a commit that referenced this issue Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants