Clean up the "state object" part of the IOType API

phetsims / tandem

Simulation-side code for PhET-iO

MIT License

0 stars 5 forks source link

Clean up the "state object" part of the IOType API #284

Open pixelzoom opened 1 year ago

pixelzoom commented 1 year ago

IOType is very inconsistent about the name that it uses for "state object". This is one of the things that makes it unnecessarily confusing. It would clearer ifstateObject were used everywhere, instead of state, s, etc.

Suggestions:

[ ] Rename applyState to applyStateObject
[x] Rename stateToArgsForConstructor to stateObjectToConstructorArguments
[ ] Rename params "state", "s", and other variations to "stateObject"

samreid commented 1 year ago

Tagging for https://github.com/phetsims/phet-io/issues/1914 and self-unassigning.