Prefer "PhET-iO Type" to "IO Type", phetsims/phet-io#1972

phetsims · Jan 3, 2024 · 222931c · 222931c
1 parent bb20ac8
commit 222931c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/eslint/rules/bad-text.js b/eslint/rules/bad-text.js
@@ -71,11 +71,15 @@ module.exports = function( context ) {
     'PhET-iO element', // use "phet-io element" or "PhET-iO Element" https://github.com/phetsims/phet-io/issues/1968
     'Phet-iO',
     { id: 'IO type', regex: /\bIO type/ }, // https://github.com/phetsims/chipper/issues/977
-    // prefer IO Type name , https://github.com/phetsims/phet-io/issues/1972
+    // prefer PhET-iO Type name , https://github.com/phetsims/phet-io/issues/1972
     'IO Typename',
     'IO TypeName',
     'IO Type Name',
 
+    // prefer PhET-iO Type (public name) or IOType (class name) https://github.com/phetsims/phet-io/issues/1972
+    'IO Type',
+    ' IO type',
+
     '@return ',
 
     // see https://thenewstack.io/words-matter-finally-tech-looks-at-removing-exclusionary-language/ and

diff --git a/js/phet-io/phetioCompareAPIs.js b/js/phet-io/phetioCompareAPIs.js
@@ -345,7 +345,7 @@
 
     visit( [], referenceAPI.phetioElements, proposedAPI.phetioElements, false );
 
-    // Check for: missing IO Types, missing methods, or differing parameter types or return types
+    // Check for: missing IOTypes, missing methods, or differing parameter types or return types
     for ( const typeName in referenceAPI.phetioTypes ) {
       if ( referenceAPI.phetioTypes.hasOwnProperty( typeName ) ) {
 

diff --git a/js/phet-io/phetioCompareAPIsTests.js b/js/phet-io/phetioCompareAPIsTests.js
@@ -28,7 +28,7 @@ const DEFAULT_API = {
   phetioFullAPI: true,
   phetioTypes: {
     ObjectIO: {
-      documentation: 'The root of the IO Type hierarchy',
+      documentation: 'The root of the PhET-iO Type hierarchy',
       events: [],
       metadataDefaults: {
         phetioArchetypePhetioID: null,
@@ -65,7 +65,7 @@ qunit.test( 'basics', assert => {
     phetioElements: {
       phetioEngine: {
         _metadata: {
-          phetioDocumentation: 'Central point for PhET-iO interoperability. Please see the IO Type Documentation for API details.',
+          phetioDocumentation: 'Central point for PhET-iO interoperability. Please see the PhET-iO Type Documentation for API details.',
           phetioEventType: 'MODEL',
           phetioState: false,
           phetioTypeName: 'ObjectIO'