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

Handle EnumerationIO and EnumerationDeprecatedIO #97

Closed
zepumph opened this issue Jan 12, 2022 · 4 comments
Closed

Handle EnumerationIO and EnumerationDeprecatedIO #97

zepumph opened this issue Jan 12, 2022 · 4 comments

Comments

@zepumph
Copy link
Member

zepumph commented Jan 12, 2022

From working on renaming in #95

Steps for this issue:

  • Both EnumerationDeprecatedIO and "RichEnumerationIO" (soon to be EnumerationIO), will have the type name EnumerationIO.
  • Make them share or know about each other's cache, and assert that phetioDocumentation is not different if they share the same type name.
  • Look into combining files to see if it makes sense or is possible.

We don't think it will cause complications with PhET-iO to have them share the same name for PhET-iO because each IOType is parametrized on the actual instance of enumeration, so we know the right values will be given by the PhET-iO system.

@zepumph
Copy link
Member Author

zepumph commented Jan 12, 2022

  • Move this IO type to tandem from axon. It can't be in phet-core because it relies on tandem.

zepumph added a commit to phetsims/circuit-construction-kit-common that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/energy-forms-and-changes that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/density-buoyancy-common that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/capacitor-lab-basics that referenced this issue Jan 13, 2022
@zepumph
Copy link
Member Author

zepumph commented Jan 13, 2022

Alright, with only a limited addition of API in EnumerationDeprecated, I was able to consolidate EnumerationIO types. There is now just a single IOType, in tandem, that both EnumerationDeprecated and Enumeration use. I think that this issue is ready for review by @samreid once everything get's pushed.

zepumph added a commit to phetsims/states-of-matter that referenced this issue Jan 13, 2022
@zepumph zepumph assigned samreid and unassigned zepumph Jan 13, 2022
zepumph added a commit that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/tandem that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/tandem that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/axon that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/dot that referenced this issue Jan 13, 2022
zepumph added a commit to phetsims/greenhouse-effect that referenced this issue Jan 13, 2022
@zepumph
Copy link
Member Author

zepumph commented Jan 13, 2022

Most important for the review @samreid: will you please make sure that the changes to ts-config files are as expected. I exclusively removed include/exclude paths, but they all seemed like workarounds, so I hope all is well here!

@samreid
Copy link
Member

samreid commented Apr 23, 2022

I reviewed all the commits and didn't see any problems. I skimmed the changes in tsconfig files and they seem reasonable. I think tsc would have told us if some file was out of scope. Can this issue be closed?

@samreid samreid assigned zepumph and unassigned samreid Apr 23, 2022
@zepumph zepumph closed this as completed Apr 25, 2022
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

2 participants