Add phetioDocumentation, see #827

phetsims · Sep 8, 2022 · fe966e2 · fe966e2
1 parent 9719c1d
commit fe966e2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/js/NavigationBar.ts b/js/NavigationBar.ts
@@ -162,8 +162,8 @@ class NavigationBar extends Node {
 
       const isUserNavigableProperty = new BooleanProperty( true, {
         tandem: Tandem.GENERAL_MODEL.createTandem( 'screens' ).createTandem( 'isUserNavigableProperty' ),
-        phetioFeatured: true
-        // TODO: phetioDocumentation, see https://github.com/phetsims/joist/issues/827
+        phetioFeatured: true,
+        phetioDocumentation: 'If the screens are user navigable, icons are displayed in the navigation bar and the user can switch between screens.'
       } );
 
       // pdom - container for the homeButton and all the screen buttons.

diff --git a/js/Sim.ts b/js/Sim.ts
@@ -490,8 +490,8 @@ export default class Sim extends PhetioObject {
           tandem: screensTandem.createTandem( 'availableScreensProperty' ),
           isValidValue: value => _.some( validValues, validValue => _.isEqual( value, validValue ) ),
           phetioFeatured: true,
-          phetioValueType: ArrayIO( NumberIO )
-          // TODO: phetioDocumentation, see https://github.com/phetsims/joist/issues/827
+          phetioValueType: ArrayIO( NumberIO ),
+          phetioDocumentation: 'Controls which screens are available, and the order they are displayed.'
         } );
 
         this.activeSimScreensProperty = new DerivedProperty( [ this.availableScreensProperty ], screenIndices => {