phetsims / molarity

"Molarity" is an educational simulation in HTML5, by PhET Interactive Simulations.
http://phet.colorado.edu/en/simulation/molarity
GNU General Public License v3.0
2 stars 6 forks source link

useQuantitativeDescriptions name violates PhET naming convention #101

Closed pixelzoom closed 5 years ago

pixelzoom commented 5 years ago

From the code-review checklist:

  • [ ] Naming for Property values: All AXON/Property instances should be declared with the suffix Property. For example, if a visible property is added, it should have the name visibleProperty instead of simply visible. This will help to avoid confusion with non-Property definitions.

In MolarityScreenView:

    // Determines whether qualitative or quantitative a11y descriptions are used.
    const useQuantitativeDescriptions = new DerivedProperty( [ valuesVisibleProperty ], () => {
      return valuesVisibleProperty.value;
    } );

This should be named useQuantitativeDescriptionsProperty. By convention, a Property is always named with a "Property" suffix.

This name also needs to be fixed in MolarityScreenSummaryNode and *Describer classes.

twant commented 5 years ago

Thanks for catching this, @pixelzoom. Updated and assigned back over to you.

pixelzoom commented 5 years ago

Perfect @twant, thanks for making the change. Closing.