docs: update examples and rearrange tests

Author: kgryte

lib/node_modules/@stdlib/math/base/tools/evalpoly/docs/types/index.d.ts

@@ -28,7 +28,7 @@ import { Collection } from '@stdlib/types/array';
 * @param x - value at which to evaluate a polynomial
 * @returns evaluated polynomial
 */
-type EvaluationFunction = ( x: number ) => number;
+type PolynomialFunction = ( x: number ) => number;
 
 /**
 * Interface for evaluating polynomials.
@@ -49,7 +49,7 @@ interface EvalPoly {
 	* @returns evaluated polynomial
 	*
 	* @example
-	* var v = evalpoly( [3.0,2.0,1.0], 10.0 ); // 3*10^0 + 2*10^1 + 1*10^2
+	* var v = evalpoly( [ 3.0, 2.0, 1.0 ], 10.0 ); // 3*10^0 + 2*10^1 + 1*10^2
 	* // returns 123.0
 	*/
 	( c: Collection<number>, x: number ): number;
@@ -68,15 +68,15 @@ interface EvalPoly {
 	* @returns function for evaluating a polynomial
 	*
 	* @example
-	* var polyval = evalpoly.factory( [3.0,2.0,1.0] );
+	* var polyval = evalpoly.factory( [ 3.0, 2.0, 1.0 ] );
 	*
 	* var v = polyval( 10.0 ); // => 3*10^0 + 2*10^1 + 1*10^2
 	* // returns 123.0
 	*
 	* v = polyval( 5.0 ); // => 3*5^0 + 2*5^1 + 1*5^2
 	* // returns 38.0
 	*/
-	factory( c: Collection<number> ): EvaluationFunction;
+	factory( c: Collection<number> ): PolynomialFunction;
 }
 
 /**
@@ -94,11 +94,11 @@ interface EvalPoly {
 * @returns evaluated polynomial
 *
 * @example
-* var v = evalpoly( [3.0,2.0,1.0], 10.0 ); // 3*10^0 + 2*10^1 + 1*10^2
+* var v = evalpoly( [ 3.0, 2.0, 1.0 ], 10.0 ); // 3*10^0 + 2*10^1 + 1*10^2
 * // returns 123.0
 *
 * @example
-* var polyval = evalpoly.factory( [3.0,2.0,1.0] );
+* var polyval = evalpoly.factory( [ 3.0, 2.0, 1.0 ] );
 *
 * var v = polyval( 10.0 ); // => 3*10^0 + 2*10^1 + 1*10^2
 * // returns 123.0

lib/node_modules/@stdlib/math/base/tools/evalpoly/docs/types/test.ts

@@ -57,7 +57,17 @@ import evalpoly = require( './index' );
 // Attached to main export is a `factory` method which returns a function...
 {
 	const c = [ 3.0, 2.0, 1.0 ];
-	evalpoly.factory( c ); // $ExpectType EvaluationFunction
+	evalpoly.factory( c ); // $ExpectType PolynomialFunction
+}
+
+// The compiler throws an error if the `factory` method is provided a first argument which is not an array of numbers...
+{
+	evalpoly.factory( true ); // $ExpectError
+	evalpoly.factory( false ); // $ExpectError
+	evalpoly.factory( 'abc' ); // $ExpectError
+	evalpoly.factory( 123 ); // $ExpectError
+	evalpoly.factory( {} ); // $ExpectError
+	evalpoly.factory( ( x: number ): number => x ); // $ExpectError
 }
 
 // The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
@@ -74,7 +84,7 @@ import evalpoly = require( './index' );
 	polyval( 1.0 ); // $ExpectType number
 }
 
-// The `factory` method returns a function which does not compile if provided a first argument which is not a number...
+// The compiler throws an error if the function returned by the `factory` method is provided a first argument which is not a number...
 {
 	const c = [ 3.0, 2.0, 1.0 ];
 	const polyval = evalpoly.factory( c );
@@ -85,13 +95,3 @@ import evalpoly = require( './index' );
 	polyval( {} ); // $ExpectError
 	polyval( ( x: number ): number => x ); // $ExpectError
 }
-
-// The compiler throws an error if the `factory` method is provided a first argument which is not an array of numbers...
-{
-	evalpoly.factory( true ); // $ExpectError
-	evalpoly.factory( false ); // $ExpectError
-	evalpoly.factory( 'abc' ); // $ExpectError
-	evalpoly.factory( 123 ); // $ExpectError
-	evalpoly.factory( {} ); // $ExpectError
-	evalpoly.factory( ( x: number ): number => x ); // $ExpectError
-}