add documentation for IOTypes, #241

phetsims · May 14, 2024 · 364d8a8 · 364d8a8
1 parent 043d7bd
commit 364d8a8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/js/diffusion/model/ParticleFlowRateModel.ts b/js/diffusion/model/ParticleFlowRateModel.ts
@@ -162,8 +162,8 @@ export default class ParticleFlowRateModel extends PhetioObject {
   private static readonly ParticleFlowRateModelIO = new IOType<ParticleFlowRateModel, ParticleFlowRateModelStateObject>( 'ParticleFlowRateModelIO', {
     valueType: ParticleFlowRateModel,
     stateSchema: STATE_SCHEMA,
-    documentation: 'PhET-iO Type that does sampling of the flow rate for one type of particle. ' +
-                   'All fields in the State Schema are for internal use only.'
+    documentation: 'PhET-iO Type that supports sampling of the flow rate for one type of particle. ' +
+                   'All fields in this type are for internal use only.'
     // toStateObject: Use the default, which is derived from stateSchema.
     // applyState: Use the default, which is derived from stateSchema.
   } );

diff --git a/js/energy/model/AverageSpeedModel.ts b/js/energy/model/AverageSpeedModel.ts
@@ -199,8 +199,8 @@ export default class AverageSpeedModel extends PhetioObject {
   private static readonly AverageSpeedModelIO = new IOType<AverageSpeedModel, AverageSpeedModelStateObject>( 'AverageSpeedModelIO', {
     valueType: AverageSpeedModel,
     stateSchema: STATE_SCHEMA,
-    documentation: 'PhET-iO Type that does sampling of the Average Speed of the particle system. ' +
-                   'All fields in the State Schema are for internal use only.'
+    documentation: 'PhET-iO Type that supports sampling of the Average Speed of the particle system. ' +
+                   'All fields in this type are for internal use only.'
     // toStateObject: Use the default, which is derived from stateSchema.
     // applyState: Use the default, which is derived from stateSchema.
   } );

diff --git a/js/energy/model/HistogramsModel.ts b/js/energy/model/HistogramsModel.ts
@@ -341,8 +341,8 @@ export default class HistogramsModel extends PhetioObject {
   private static readonly HistogramsModelIO = new IOType<HistogramsModel, HistogramsModelStateObject>( 'HistogramsModelIO', {
     valueType: HistogramsModel,
     stateSchema: STATE_SCHEMA,
-    documentation: 'PhET-iO Type that does sampling of the Speed and Kinetic Energy of the particle system. ' +
-                   'All fields in the State Schema are for internal use only.'
+    documentation: 'PhET-iO Type that supports sampling of the Speed and Kinetic Energy of the particle system. ' +
+                   'All fields this type are for internal use only.'
     // toStateObject: Use the default, which is derived from stateSchema.
     // applyState: Use the default, which is derived from stateSchema.
   } );