Adding review comments to doc. #63

phetsims · Aug 31, 2018 · 44e1454 · 44e1454
1 parent 91f6ead
commit 44e1454
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/js/common/model/Charge.js b/js/common/model/Charge.js
@@ -51,6 +51,7 @@ define( function( require ) {
     // @public - object node color is will change with value
     // color property will be updated based on a boolean value (negative vs positive)
     // brightness will be set according to the Mass/Charge magnitude
+    // REVIEW: Use Property instead of property in above comment
     // REVIEW: Visibility annotation? Type Doc?
     // REVIEW: Should this be @protected visibility annotation? I may be wrong here.
     this.baseColorProperty = new DerivedProperty( [ this.valueProperty ], function( value ) {

diff --git a/js/common/view/ChargeControl.js b/js/common/view/ChargeControl.js
@@ -27,6 +27,7 @@ define( function( require ) {
    * @param {string} unitString - for the NumberControl readout
    * @param {Property.<number>} objectProperty - the number Property associated with the ISLCObject
    * @param {Range} valueRange - max and min values for the object property, used for display and as NumberControl argument
+   *     // REVIEW: Use Property instead of property in "object property" above
    * @param {number} scaleFactor - multiplicative constant for getting proper readouts/positions on Macro and Atomic screens
    * @param {Tandem} tandem // TODO: move to options
    * @param {Object} options
@@ -50,10 +51,12 @@ define( function( require ) {
     // @public
     // intermediate property to allow for scaling between atomic units and microcoulombs
     // value ranges from -10 to 10 and unit can be e or mc
+    // REVIEW: Use Property instead of property in above comment
     // REVIEW: Type doc? Consider using numberProperty
     this.chargeControlProperty = new Property( objectProperty.get() * scaleFactor );
 
     // no unlinking/disposing required as property is never destroyed
+    // REVIEW: Use Property instead of property in above comment
     this.chargeControlProperty.link( function( value ) {
       objectProperty.set( value / scaleFactor );
     } );

diff --git a/js/common/view/ChargeNode.js b/js/common/view/ChargeNode.js
@@ -3,6 +3,7 @@
 /**
  * Scenery node for the charge object. Children include the pusher/pullers, the circular charge, the force arrow, and
  * all labels. Most instantiation details are handled in ISLCObjectNode including all property linking and drawing.
+ // REVIEW: Use Property instead of property in above comment
  *
  * @author Jesse Greenberg (PhET Interactive Simulations)
  * @author Michael Barlow (PhET Interactive Simulations)