Skip to content

Commit

Permalink
rename tandem.isSuppliedAndEnabled to PhetioObject.isPhetioInstrument…
Browse files Browse the repository at this point in the history
  • Loading branch information
zepumph committed Oct 4, 2018
1 parent 003f330 commit c36ed9f
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion js/input/SimpleDragHandler.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ define( function( require ) {
phetioReadOnly: true,
phetioState: false,
tandem: options.tandem.createTandem( 'isDraggingProperty' ),
phetioInstanceDocumentation: 'Indicates whether the object is dragging'
phetioDocumentation: 'Indicates whether the object is dragging'
} );

this.pointer = null; // the pointer doing the current dragging
Expand Down
2 changes: 1 addition & 1 deletion js/listeners/DragListener.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ define( function( require ) {
// @private {Emitter} - emitted on drag. Used for triggering phet-io events, see https://github.com/phetsims/scenery/issues/842
this._draggedEmitter = new Emitter( {
tandem: options.tandem.createTandem( 'draggedEmitter' ),
phetioInstanceDocumentation: 'Emits whenever a drag occurs with an EventIO argument.',
phetioDocumentation: 'Emits whenever a drag occurs with an EventIO argument.',
phetioReadOnly: options.phetioReadOnly,
phetioEventType: 'user',
phetioType: EmitterIO( [ EventIO ] )
Expand Down
6 changes: 3 additions & 3 deletions js/listeners/PressListener.js
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,8 @@ define( function( require ) {
// @private {Emitter} - emitted on press event
this._pressedEmitter = new Emitter( {
tandem: options.tandem.createTandem( 'pressedEmitter' ),
phetioInstanceDocumentation: 'Emits whenever a press occurs. The first argument when emitting can be ' +
'used to convey info about the Event.',
phetioDocumentation: 'Emits whenever a press occurs. The first argument when emitting can be ' +
'used to convey info about the Event.',
phetioReadOnly: options.phetioReadOnly,
phetioEventType: 'user',
phetioType: EmitterIO( [ EventIO, VoidIO, VoidIO ] )
Expand Down Expand Up @@ -305,7 +305,7 @@ define( function( require ) {
// @private - emitted on release event
this._releasedEmitter = new Emitter( {
tandem: options.tandem.createTandem( 'releasedEmitter' ),
phetioInstanceDocumentation: 'Emits whenever a release occurs.',
phetioDocumentation: 'Emits whenever a release occurs.',
phetioReadOnly: options.phetioReadOnly,
phetioEventType: 'user',
phetioType: EmitterIO( [ VoidIO ] )
Expand Down
6 changes: 3 additions & 3 deletions js/nodes/NodeIO.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ define( function( require ) {
phetioType: PropertyIO( BooleanIO ),

tandem: node.tandem.createTandem( 'visibleProperty' ),
phetioInstanceDocumentation: 'Controls whether the Node will be visible (and interactive), see the NodeIO documentation for more details.'
phetioDocumentation: 'Controls whether the Node will be visible (and interactive), see the NodeIO documentation for more details.'
} );

var pickableProperty = new NodeProperty( node, 'pickability', 'pickable', {
Expand All @@ -52,7 +52,7 @@ define( function( require ) {

tandem: node.tandem.createTandem( 'pickableProperty' ),
phetioType: PropertyIO( NullableIO( BooleanIO ) ),
phetioInstanceDocumentation: 'Sets whether the node will be pickable (and hence interactive), see the NodeIO documentation for more details'
phetioDocumentation: 'Sets whether the node will be pickable (and hence interactive), see the NodeIO documentation for more details'
} );

// Adapter for the opacity. Cannot use NodeProperty at the moment because it doesn't handle numeric types
Expand All @@ -65,7 +65,7 @@ define( function( require ) {

tandem: node.tandem.createTandem( 'opacityProperty' ),
range: { min: 0, max: 1 },
phetioInstanceDocumentation: 'Opacity of the parent NodeIO, between 0 (invisible) and 1 (fully visible)'
phetioDocumentation: 'Opacity of the parent NodeIO, between 0 (invisible) and 1 (fully visible)'
} );
opacityProperty.link( function( opacity ) { node.opacity = opacity; } );
node.on( 'opacity', function() { opacityProperty.value = node.opacity; } );
Expand Down
2 changes: 1 addition & 1 deletion js/nodes/RichTextIO.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ define( function( require ) {
phetioType: PropertyIO( StringIO ),

tandem: richText.tandem.createTandem( 'textProperty' ),
phetioInstanceDocumentation: 'Property for the displayed text'
phetioDocumentation: 'Property for the displayed text'
} );

// @private
Expand Down
2 changes: 1 addition & 1 deletion js/nodes/TextIO.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ define( function( require ) {
phetioType: PropertyIO( StringIO ),

tandem: text.tandem.createTandem( 'textProperty' ),
phetioInstanceDocumentation: 'Property for the displayed text'
phetioDocumentation: 'Property for the displayed text'
} );

// @private
Expand Down

1 comment on commit c36ed9f

@zepumph
Copy link
Member Author

@zepumph zepumph commented on c36ed9f Oct 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename instance doc to phetioDocumentation, phetsims/tandem#63

Please sign in to comment.