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

nonstandard names for model classes #271

Closed
pixelzoom opened this issue Dec 18, 2018 · 2 comments
Closed

nonstandard names for model classes #271

pixelzoom opened this issue Dec 18, 2018 · 2 comments

Comments

@pixelzoom
Copy link
Contributor

Related to code review #259.

The screen names in this sim are Waves, Interference, Slits, and Diffraction. So based on other sims that I've reviewed, I'd expect to find top-level model classes WavesModel, InterferenceModel, SlitsModel, and DiffractionModel respectively. DiffractionModel is as expected. But the others are WavesScreenModel, InterferenceScreenModel, SlitsScreenModel.

Searching for "ScreenModel" shows that this naming scheme is also used in circuit-construction-kit-dc and circuit-construction-kit-black-box-study. The naming convention used in all other sims has served us well, and I see no benefit to deviating or changing. So unless there's a really good reason to spend time in a dev meeting discussing a different naming convention, I recommend to rename the model classes in this sim, circuit-construction-kit-dc, and circuit-construction-kit-black-box-study

@samreid samreid mentioned this issue Dec 18, 2018
samreid added a commit to phetsims/circuit-construction-kit-black-box-study that referenced this issue Dec 20, 2018
samreid added a commit to phetsims/circuit-construction-kit-basics that referenced this issue Dec 20, 2018
samreid added a commit to phetsims/circuit-construction-kit-dc that referenced this issue Dec 20, 2018
@samreid
Copy link
Member

samreid commented Dec 20, 2018

Proposed fixes pushed for Wave Interference and Circuit Construction Kit, ready for review.

@pixelzoom
Copy link
Contributor Author

👍 Closing.

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