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

Screen, ScreenView, and model class names don't follow PhET naming conventions #121

Open
pixelzoom opened this issue Oct 12, 2020 · 0 comments

Comments

@pixelzoom
Copy link
Contributor

Noted while converting ScreenView subclasses to class for phetsims/tasks#1044.

Screen, ScreenView, and model classes do not follow PhET naming conventions. Their prefix should be the screen name. And for Screens and ScreenViews, their suffix should be "Screen" and "ScreenView" respectively.

Here are the name changes that follow PhET conventions:

CoulombsLawAtomicScreen -> AtomicScaleScreen
CoulombsLawAtomicView -> AtomicScaleScreenView
CoulombsLawAtomicModel -> AtomicScaleModel

CoulombsLawMacroScreen -> MacroScaleScreen
CoulombsLawMacroView -> MacroScaleScreenView
CoulombsLawMacroModel -> MacroScaleModel

CoulombsLawCommonView -> CoulombsLawCommonScreenView, or (more typically) CoulombsLawScreenView
CoulombsLawCommonModel -> more typically CoulombsLawModel

This bogus type expressions also appears throughout the code:

@param {CoulombsLawModel} coulombsLawModel
@zepumph zepumph removed their assignment Mar 3, 2023
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