phetsims / greenhouse-effect

"Greenhouse Effect" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
4 stars 4 forks source link

Inconsistent naming related to "Show Surface Temperature" checkbox #323

Closed pixelzoom closed 12 months ago

pixelzoom commented 12 months ago

There's some inconsistency in the naming associated with this checkbox, and it's unfortunately exposed by PhET-iO:

screenshot_2657

It is currently implemented in class SurfaceTemperatureCheckbox, with string showSurfaceTemperatureStringProperty, and tandem name surfaceTemperatureCheckbox. So the "Show" bit is sometimes there, sometimes not there.

Options:

(1) Do nothing.

(2) Rename class SurfaceTemperatureCheckbox to ShowSurfaceTemperatureCheckbox, and tandem surfaceTemperatureCheckbox to showSurfaceTemperatureCheckbox

(3) Rename showSurfaceTemperatureStringProperty to surfaceTemperatureStringProperty, change its key to "surfaceTemperature", and change its value to "Surface Temperature". (This string is not used in Molecules and Light, but might have been used in Greenhouse Effect prototype.)

@arouinfar what would you like to do?

arouinfar commented 12 months ago

Thanks @pixelzoom. I vote for option (2). Naming this control has been tricky. I would prefer to keep it "Show Surface Temperature" in the sim, and update the class and tandem names to match.

pixelzoom commented 12 months ago

@arouinfar please review, close if OK.

screenshot_2661
arouinfar commented 12 months ago

Looks good, thanks @pixelzoom.