Add TODOS, see: #164

phetsims · May 10, 2023 · 0ed4718 · 0ed4718
1 parent 5481698
commit 0ed4718
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 7 deletions.
diff --git a/js/common/model/CAVModel.ts b/js/common/model/CAVModel.ts
@@ -1,5 +1,11 @@
 // Copyright 2023, University of Colorado Boulder
 
+/**
+ * TODO: Describe file, https://github.com/phetsims/center-and-variability/issues/164
+ *
+ * @author Sam Reid (PhET Interactive Simulations)
+ */
+
 import centerAndVariability from '../../centerAndVariability.js';
 import NumberProperty from '../../../../axon/js/NumberProperty.js';
 import BooleanProperty from '../../../../axon/js/BooleanProperty.js';

diff --git a/js/common/model/CAVSceneModel.ts b/js/common/model/CAVSceneModel.ts
@@ -1,7 +1,8 @@
 // Copyright 2022-2023, University of Colorado Boulder
 
 /**
- * Base class for the model in every screen.
+ * Base class for the scene model in a screen. The Median and Mean & Median screens only have one scene model.
+ * The Variability screen has 4 scene models.
  *
  * @author Chris Klusendorf (PhET Interactive Simulations)
  * @author Sam Reid (PhET Interactive Simulations)
@@ -546,8 +547,7 @@ export default class CAVSceneModel extends PhetioObject implements TModel {
     const angle = dotRandom.nextDoubleBetween( degreesToRadians( 25 ), degreesToRadians( 70 ) );
     const v0 = Math.sqrt( Math.abs( x1 * Math.abs( CAVConstants.GRAVITY ) / Math.sin( 2 * angle ) ) );
 
-    const velocity = Vector2.createPolar( v0, angle );
-    soccerBall.velocityProperty.value = velocity;
+    soccerBall.velocityProperty.value = Vector2.createPolar( v0, angle );
 
     soccerBall.targetXProperty.value = x1;
 

diff --git a/js/common/view/SceneView.ts b/js/common/view/SceneView.ts
@@ -1,4 +1,9 @@
 // Copyright 2023, University of Colorado Boulder
+/**
+ * TODO: Describe file, https://github.com/phetsims/center-and-variability/issues/164
+ *
+ * @author Sam Reid (PhET Interactive Simulations)
+ */
 
 import { Node } from '../../../../scenery/js/imports.js';
 import SoccerBallNode from './SoccerBallNode.js';
@@ -170,19 +175,19 @@ export default class SceneView {
         const soccerBallNode = soccerBallMap.get( stack[ i ] )!;
         const selfZIndex = soccerBallNode.parent!.indexOfChild( soccerBallNode );
 
-        let isMisorded = false;
+        let isMisordered = false;
 
         const lowerNeighborIndex = i - 1;
         if ( lowerNeighborIndex >= 0 ) {
           const lowerSoccerBall = soccerBallMap.get( stack[ lowerNeighborIndex ] )!;
           const otherZIndex = lowerSoccerBall.parent!.indexOfChild( lowerSoccerBall );
 
           if ( selfZIndex < otherZIndex ) {
-            isMisorded = true;
+            isMisordered = true;
           }
         }
 
-        if ( isMisorded ) {
+        if ( isMisordered ) {
           soccerBallNode.moveToFront();
         }
       }

diff --git a/js/variability/model/VariabilitySceneModel.ts b/js/variability/model/VariabilitySceneModel.ts
@@ -1,5 +1,12 @@
 // Copyright 2022-2023, University of Colorado Boulder
 
+/**
+ * TODO: Describe file, https://github.com/phetsims/center-and-variability/issues/164
+ *
+ * @author Sam Reid (PhET Interactive Simulations)
+ */
+
+
 import CAVSceneModel from '../../common/model/CAVSceneModel.js';
 import centerAndVariability from '../../centerAndVariability.js';
 import TReadOnlyProperty from '../../../../axon/js/TReadOnlyProperty.js';

diff --git a/js/variability/view/SceneRadioButtonGroup.ts b/js/variability/view/SceneRadioButtonGroup.ts
@@ -1,5 +1,11 @@
 // Copyright 2023, University of Colorado Boulder
 
+/**
+ * TODO: Describe file, https://github.com/phetsims/center-and-variability/issues/164
+ *
+ * @author Sam Reid (PhET Interactive Simulations)
+ */
+
 import RectangularRadioButtonGroup, { RectangularRadioButtonGroupOptions } from '../../../../sun/js/buttons/RectangularRadioButtonGroup.js';
 import centerAndVariability from '../../centerAndVariability.js';
 import optionize, { EmptySelfOptions } from '../../../../phet-core/js/optionize.js';
@@ -36,7 +42,7 @@ export default class SceneRadioButtonGroup extends RectangularRadioButtonGroup<C
         fontWeight: 'bold',
         fill: 'white',
 
-        // Adjust for offcentering
+        // Adjust for off-centering
         center: path.center.plusXY( -0.5, 0 ),
         stroke: 'black',
         lineWidth: 0.8
@@ -45,6 +51,7 @@ export default class SceneRadioButtonGroup extends RectangularRadioButtonGroup<C
         children: [ path, text ]
       } );
     };
+
     super( property, [ {
       value: sceneModels[ 0 ],
       createNode: tandem => createTShirtIcon( tandem, '1', '#7bb772' ),