-
Notifications
You must be signed in to change notification settings - Fork 6
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
nonintuitive and misleading type names #192
Comments
|
I've renamed three of the files, let me know if these names seem clear enough to you. Regarding RightControlPanel, it is difficult to name it something related to its content since it has 3 sections. ModeGravityCheckboxControlPanel seems weird. What do you think about these?
|
Let's go with |
Related to code review #173.
Some (many?) of the type names in this sim are nonintuitive and downright misleading, making it unnecessarily difficult to navigate the code, or locate things by guessing their names. This is no fault of @aaronsamuel137, it was inherited.
Some examples, not exhaustive:
• SpaceObjectsPropertyCheckbox - it's not a Property or a CheckBox, it's a Panel. SpaceObjectsPanel would be better. (What is a "space object", btw?)
• GravityModeMenu - it's not a menu, it's a pair of on/off radio buttons. GravityControl would be better.
• PlanetModeMenu - it's not a menu, it's a set of radio buttons. And it doesn't select a planet, it selects a configuration of planets and satellites. Not sure what the proper name would be, maybe something like SystemControl?
• RightControlPanel - there are 2 control panels in the sim, and they are both on the right. How about a name that represents the nature of the stuff being controlled?
It's never fun to have to rename types (and their associated vars at call sites). But if this isn't done now, it will mean more difficult maintenance in the future.
The text was updated successfully, but these errors were encountered: