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

Add suffix "RadioButton" to individual radio buttons #334

Closed
7 tasks done
jbphet opened this issue Aug 13, 2020 · 6 comments
Closed
7 tasks done

Add suffix "RadioButton" to individual radio buttons #334

jbphet opened this issue Aug 13, 2020 · 6 comments

Comments

@jbphet
Copy link
Contributor

jbphet commented Aug 13, 2020

In the 8/13/2020 phet-io meeting we decided that radio buttons should have the suffix "RadioButton" in their tandem names. I had previous not done this because I felt that the fact that the elements were in a radio button group provided sufficient context, but since these items can be sometimes used in isolation, have a more complete name is useful.

There is a global issue that is logged in phetsims/sun#615 where an assert will be added to check this, but I don't think it's important to move this to the current 1.2 RC branch. I'll just make the change to the tandems and leave it at that.

For historical reference, the discussion that ultimately motivated this decision originated from a discussion about #331, but that issue is more about a discrepancy between the client guide and the tandems that are available in the sim.

For my own reference, here is a list of what needs to be done to make this a reality:

  • Change the code on master
    • radio button names
  • Update the client guide on master
  • Check and, if necessary, update the overrides file on master
  • Verify that the change works on master and that the phet-io wrappers work
  • Propagate these changes to the 1.2 release branch
  • Verify that it runs and builds correctly on the 1.2 release branch
@jbphet
Copy link
Contributor Author

jbphet commented Aug 13, 2020

Update: This also involves the items in combo boxes, which will impact the thermometer node.

@pixelzoom
Copy link
Contributor

pixelzoom commented Aug 13, 2020

I handled this in phetsims/sun#615. @arouinfar I fixed up the client guide too, please review.

@jbphet said:

Update: This also involves the items in combo boxes, which will impact the thermometer node.

The items in the thermometer combo box are not instrumented.

@pixelzoom
Copy link
Contributor

pixelzoom commented Aug 13, 2020

jbphet added a commit that referenced this issue Aug 13, 2020
jbphet added a commit to phetsims/states-of-matter-basics that referenced this issue Aug 14, 2020
jbphet added a commit to phetsims/states-of-matter-basics that referenced this issue Aug 14, 2020
jbphet added a commit to phetsims/states-of-matter-basics that referenced this issue Aug 14, 2020
@jbphet
Copy link
Contributor Author

jbphet commented Aug 14, 2020

I have cherry-picked the commits for SOM and the client guide to the 1.2 release branch. As for the common code, I only grabbed the one for radio button names, since the combo box changes are not particularly relevant. I updated dependencies in SOM, SOMB, and AI, and tested the release branch locally for each. I think this is ready for deployment.

@jbphet jbphet removed their assignment Aug 14, 2020
@arouinfar
Copy link
Contributor

@jbphet I added the "RadioButton" suffix to the relevant phetioIDs in SOMB's client-requests.md in the commit above. It will need to be cherry-picked into SOMB.

@phet-steele
Copy link

Looks good in phetsims/qa/issues/531 and phetsims/qa/issues/532. 🥳

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

4 participants