TODOs #192

phetsims · Oct 28, 2022 · b0c53f4 · b0c53f4
1 parent dbc97a4
commit b0c53f4
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 11 deletions.
diff --git a/js/common/model/EqualityExplorerMovable.ts b/js/common/model/EqualityExplorerMovable.ts
@@ -28,7 +28,7 @@ type SelfOptions = {
   animationSpeed?: number; // distance/second when animating
 };
 
-//TODO PickRequired<PhetioObjectOptions, 'tandem'>
+//TODO https://github.com/phetsims/equality-explorer/issues/200 add required tandem to EqualityExplorerMovableOptions
 export type EqualityExplorerMovableOptions = SelfOptions & PickOptional<PhetioObjectOptions, 'tandem'>;
 
 type AnimationCallback = ( () => void ) | null;
@@ -71,7 +71,7 @@ export default class EqualityExplorerMovable extends PhetioObject {
       animationSpeed: 400,
 
       // PhetioObjectOptions
-      tandem: Tandem.OPTIONAL, //TODO delete when tandem is required by TermOptions
+      tandem: Tandem.OPTIONAL, //TODO https://github.com/phetsims/equality-explorer/issues/200 delete when tandem is required by EqualityExplorerMovableOptions
       phetioState: false
     }, providedOptions );
 

diff --git a/js/common/model/Term.ts b/js/common/model/Term.ts
@@ -90,7 +90,7 @@ export default abstract class Term extends EqualityExplorerMovable {
       toolboxPosition: null,
 
       // EqualityExplorerMovableOptions
-      tandem: Tandem.OPTIONAL //TODO https://github.com/phetsims/equality-explorer/issues/200 delete when tandem is required by TermOptions
+      tandem: Tandem.OPTIONAL //TODO https://github.com/phetsims/equality-explorer/issues/200 delete when tandem is required by EqualityExplorerMovableOptions
     }, providedOptions );
 
     super( options );

diff --git a/js/common/view/SnapshotNode.ts b/js/common/view/SnapshotNode.ts
@@ -1,6 +1,5 @@
 // Copyright 2022, University of Colorado Boulder
 
-//TODO https://github.com/phetsims/equality-explorer/issues/191 do we need an iO-only Property whose value indicates what the displayed snapshot looks like?
 /**
  * SnapshotNode is the view of a snapshot, with optional values for the variables that appear in that snapshot.
  *

diff --git a/js/common/view/VariableTermNode.ts b/js/common/view/VariableTermNode.ts
@@ -93,15 +93,15 @@ export default class VariableTermNode extends TermNode {
    */
   public static createInteractiveTermNode( coefficient: Fraction, symbolProperty: TReadOnlyProperty<string>,
                                            providedOptions?: InteractiveTermNodeOptions ): Node {
-    return new InteractiveTermNode( coefficient, symbolProperty, providedOptions ); //TODO dynamic
+    return new InteractiveTermNode( coefficient, symbolProperty, providedOptions ); //TODO https://github.com/phetsims/equality-explorer/issues/200 dynamic
   }
 
   /**
    * Creates the representation of a term that is shown in equations.
    */
   public static createEquationTermNode( coefficient: Fraction, symbolProperty: TReadOnlyProperty<string>,
                                         providedOptions?: EquationTermNodeOptions ): Node {
-    return new EquationTermNode( coefficient, symbolProperty, providedOptions ); //TODO dynamic
+    return new EquationTermNode( coefficient, symbolProperty, providedOptions ); //TODO https://github.com/phetsims/equality-explorer/issues/200 dynamic
   }
 }
 

diff --git a/js/operations/model/OperationsScene.ts b/js/operations/model/OperationsScene.ts
@@ -174,7 +174,7 @@ export default class OperationsScene extends EqualityExplorerScene {
   public applyOperation( operation: UniversalOperation ): void {
 
     // Take a snapshot of terms on the scale, so we can undo the operation if necessary.
-    const snapshot = new Snapshot( this ); //TODO dynamic
+    const snapshot = new Snapshot( this ); //TODO https://github.com/phetsims/equality-explorer/issues/200 dynamic
 
     // TermCreators whose terms summed to zero as the result of applying this operation.
     const termCreatorsZero: TermCreator[] = [];

diff --git a/js/solveit/model/Challenge.ts b/js/solveit/model/Challenge.ts
@@ -74,8 +74,7 @@ export default class Challenge {
       b: Fraction.FractionIO.toStateObject( this.b ),
       m: Fraction.FractionIO.toStateObject( this.m ),
       n: Fraction.FractionIO.toStateObject( this.n ),
-      //TODO https://github.com/phetsims/equality-explorer/issues/191 debugDerivation is for debugging, but will show up in Studio, complete with HTML5 markup. Is it OK? Document in client guide?
-      debugDerivation: this.debugDerivation
+      debugDerivation: this.debugDerivation //TODO https://github.com/phetsims/equality-explorer/issues/191 document in client guide?
     };
   }
 

diff --git a/js/solveit/model/SolveItLevel.ts b/js/solveit/model/SolveItLevel.ts
@@ -260,13 +260,13 @@ export default class SolveItLevel extends OperationsScene {
     this.allTermCreators.forEach( termCreator => termCreator.disposeAllTerms() );
 
     // x
-    const variableTerm = new VariableTerm( this.x, { //TODO dynamic
+    const variableTerm = new VariableTerm( this.x, { //TODO https://github.com/phetsims/equality-explorer/issues/200 dynamic
       coefficient: Fraction.fromInteger( 1 ),
       diameter: EqualityExplorerConstants.BIG_TERM_DIAMETER
     } );
 
     // N
-    const constantTerm = new ConstantTerm( { //TODO dynamic
+    const constantTerm = new ConstantTerm( { //TODO https://github.com/phetsims/equality-explorer/issues/200 dynamic
       constantValue: Fraction.fromInteger( this.x.valueProperty.value ),
       diameter: EqualityExplorerConstants.BIG_TERM_DIAMETER
     } );