minor formatting and documentation, #30

phetsims · Jul 13, 2017 · 08dd27c · 08dd27c
1 parent 06ab19d
commit 08dd27c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/js/common/model/Atom.js b/js/common/model/Atom.js
@@ -48,6 +48,7 @@ define( function( require ) {
     // @public
     reset: function() {
       this.electronegativityProperty.reset();
+
       // do not reset location and partial charge, they will be reset by their parent molecule
     }
   } );

diff --git a/js/common/model/MPModel.js b/js/common/model/MPModel.js
@@ -83,23 +83,30 @@ define( function( require ) {
       // convert angle to range [0,2*PI)
       var dipoleAngle = normalizeAngle( molecule.dipoleProperty.get().angle() );
 
+      var newDipoleAngle;
+
       // move the molecular dipole one step towards alignment with the E-field
-      var newDipoleAngle = dipoleAngle;
       if ( dipoleAngle === 0 ) {
+
         // do nothing, molecule is aligned with E-field
+        newDipoleAngle = dipoleAngle;
       }
       else if ( dipoleAngle > 0 && dipoleAngle < Math.PI ) {
+
         // rotate counterclockwise
         newDipoleAngle = dipoleAngle - deltaDipoleAngle;
         if ( newDipoleAngle < 0 ) {
+
           // new angle would overshoot, set to zero
           newDipoleAngle = 0;
         }
       }
       else {
+
         // rotate clockwise
         newDipoleAngle = dipoleAngle + deltaDipoleAngle;
         if ( newDipoleAngle > 2 * Math.PI ) {
+
           // new angle would overshoot, set to zero
           newDipoleAngle = 0;
         }

diff --git a/js/common/view/SurfaceColorKey.js b/js/common/view/SurfaceColorKey.js
@@ -1,7 +1,8 @@
 // Copyright 2014-2017, University of Colorado Boulder
 
 /**
- * Key for a surface's color scheme.
+ * Key for a surface's color scheme. This legend is a rectangular box with a gradient fill that matches the surface
+ * in the Molecule. Each label is a unit for a color.
  *
  * @author Chris Malley (PixelZoom, Inc.)
  */