Skip to content

Commit

Permalink
rename instance doc to phetioDocumentation, #63
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Oct 4, 2018
1 parent 75d63ab commit bdb193f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions js/PhetioObject.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ define( function( require ) {
phetioType: ObjectIO, // Supply the appropriate IO type
phetioState: true, // When true, includes the instance in the PhET-iO state
phetioReadOnly: false, // When true, you can only get values from the instance; no setting allowed.
phetioInstanceDocumentation: null, // Useful notes about an instrumented instance, shown in the PhET-iO Studio Wrapper
phetioDocumentation: null, // Useful notes about an instrumented instance, shown in the PhET-iO Studio Wrapper
phetioEventType: 'model' // Default event type for this instance, can be overriden in phetioStartEvent options
};

Expand Down Expand Up @@ -58,7 +58,7 @@ define( function( require ) {
this.phetioReadOnly = null;

// @public (read-only) {string} - assigned in initializePhetioObject - Notes about an instance, shown in the PhET-iO Studio Wrapper
this.phetioInstanceDocumentation = null;
this.phetioDocumentation = null;

// @public (read-only) {Object} - assigned in initializePhetioObject - The wrapper instance for PhET-iO interoperation
this.phetioWrapper = null;
Expand Down Expand Up @@ -138,12 +138,12 @@ define( function( require ) {
this.phetioState = options.phetioState;
this.phetioReadOnly = options.phetioReadOnly;
this.phetioEventType = options.phetioEventType;
this.phetioInstanceDocumentation = options.phetioInstanceDocumentation;
this.phetioDocumentation = options.phetioDocumentation;

// Instantiate the wrapper instance which is used for PhET-iO communication
if ( PHET_IO_ENABLED && this.tandem.supplied ) {
// this assertion should be enabled for new phet-io sim publications
// assert && assert( this.phetioInstanceDocumentation, 'Instance documentation is required for: ' + this.tandem.phetioID );
// assert && assert( this.phetioDocumentation, 'Instance documentation is required for: ' + this.tandem.phetioID );
this.phetioWrapper = new this.phetioType( this, this.tandem.phetioID );
}

Expand Down

0 comments on commit bdb193f

Please sign in to comment.