docs: update to support data type objects and be opaque regarding return value

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/README.md

@@ -46,16 +46,22 @@ Resolves the output ndarray [data type][@stdlib/ndarray/dtypes] for a unary func
 
 ```javascript
 var dt = unaryOutputDataType( 'int32', 'floating_point' );
+
+var s = String( dt );
 // returns 'float64'
 ```
 
 If `policy` is a [data type][@stdlib/ndarray/dtypes], the function always returns the `policy` value (i.e., the second argument).
 
 ```javascript
 var dt = unaryOutputDataType( 'float32', 'float64' );
+
+var s = String( dt );
 // returns 'float64'
 
 dt = unaryOutputDataType( 'int32', 'float64' );
+
+s = String( dt );
 // returns 'float64'
 
 // ...

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/benchmark/benchmark.js

@@ -23,6 +23,7 @@
 var bench = require( '@stdlib/bench' );
 var isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
 var dtypes = require( '@stdlib/ndarray/dtypes' );
+var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var resolve = require( './../lib' );
 
@@ -34,15 +35,15 @@ var DTYPES = dtypes( 'numeric' );
 
 // MAIN //
 
-bench( pkg+':policy=default', function benchmark( b ) {
+bench( format( '%s:policy=default', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'default' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -53,15 +54,15 @@ bench( pkg+':policy=default', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=same', function benchmark( b ) {
+bench( format( '%s:policy=same', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'same' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -72,15 +73,15 @@ bench( pkg+':policy=same', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=promoted', function benchmark( b ) {
+bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'promoted' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -91,15 +92,15 @@ bench( pkg+':policy=promoted', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=real', function benchmark( b ) {
+bench( format( '%s:policy=real', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'real' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -110,15 +111,15 @@ bench( pkg+':policy=real', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=floating_point', function benchmark( b ) {
+bench( format( '%s:policy=floating_point', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'floating_point' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -129,15 +130,15 @@ bench( pkg+':policy=floating_point', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=real_floating_point', function benchmark( b ) {
+bench( format( '%s:policy=real_floating_point', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'real_floating_point' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -148,15 +149,15 @@ bench( pkg+':policy=real_floating_point', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=complex_floating_point', function benchmark( b ) {
+bench( format( '%s:policy=complex_floating_point', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'complex_floating_point' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -167,15 +168,15 @@ bench( pkg+':policy=complex_floating_point', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=integer', function benchmark( b ) {
+bench( format( '%s:policy=integer', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'integer' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -186,15 +187,15 @@ bench( pkg+':policy=integer', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=signed_integer', function benchmark( b ) {
+bench( format( '%s:policy=signed_integer', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'signed_integer' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -205,15 +206,15 @@ bench( pkg+':policy=signed_integer', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=unsigned_integer', function benchmark( b ) {
+bench( format( '%s:policy=unsigned_integer', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'unsigned_integer' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -224,15 +225,15 @@ bench( pkg+':policy=unsigned_integer', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=numeric', function benchmark( b ) {
+bench( format( '%s:policy=numeric', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'numeric' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();
@@ -243,15 +244,15 @@ bench( pkg+':policy=numeric', function benchmark( b ) {
 	b.end();
 });
 
-bench( pkg+':policy=<dtype>', function benchmark( b ) {
+bench( format( '%s:policy=<dtype>', pkg ), function benchmark( b ) {
 	var out;
 	var i;
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		out = resolve( DTYPES[ i%DTYPES.length ], 'int32' );
-		if ( typeof out !== 'string' ) {
-			b.fail( 'should return a string' );
+		if ( typeof out === 'boolean' ) {
+			b.fail( 'should return a data type' );
 		}
 	}
 	b.toc();

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/docs/repl.txt

@@ -4,21 +4,22 @@
 
     Parameters
     ----------
-    dtype: string
+    dtype: string|DataType
         Input ndarray data type.
 
-    policy: string
+    policy: string|DataType
         Output ndarray data type policy. If `policy` is a data type, the
         function returns the `policy` value.
 
     Returns
     -------
-    out: string
+    out: DataType
         Output ndarray data type.
 
     Examples
     --------
-    > var out = {{alias}}( 'float64', 'real' )
+    > var dt = {{alias}}( 'float64', 'real' );
+    > String( dt )
     'float64'
 
     See Also

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/docs/types/index.d.ts

@@ -31,7 +31,7 @@ import { DataType, OutputPolicy } from '@stdlib/types/ndarray';
 *
 * @example
 * var dt = outputDataType( 'float64', 'complex_floating_point' );
-* // returns <string>
+* // returns <DataType>
 */
 declare function outputDataType( dtype: DataType, policy: OutputPolicy | DataType ): DataType;
 

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/lib/index.js

@@ -27,7 +27,7 @@
 * var resolve = require( '@stdlib/ndarray/base/unary-output-dtype' );
 *
 * var dt = resolve( 'float64', 'complex_floating_point' );
-* // returns <string>
+* // returns <DataType>
 */
 
 // MODULES //

lib/node_modules/@stdlib/ndarray/base/unary-output-dtype/lib/main.js

@@ -28,14 +28,14 @@ var outputDataType = require( '@stdlib/ndarray/base/output-dtype' );
 /**
 * Resolves the output ndarray data type for a unary function.
 *
-* @param {string} dtype - input ndarray data type
-* @param {string} policy - output ndarray data type policy
+* @param {*} dtype - input ndarray data type
+* @param {(string|*)} policy - output ndarray data type policy
 * @throws {TypeError} second argument must be a recognized data type policy
-* @returns {string} output ndarray data type
+* @returns {DataType} output ndarray data type
 *
 * @example
 * var dt = resolve( 'float64', 'complex_floating_point' );
-* // returns <string>
+* // returns <DataType>
 */
 function resolve( dtype, policy ) {
 	return outputDataType( [ dtype ], policy );