docs: clean-up

lib/node_modules/@stdlib/array/datespace/docs/types/index.d.ts

@@ -51,7 +51,7 @@ interface Options {
 * // returns [...]
 *
 * // Equivalent of Math.round():
-* var arr = datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
+* arr = datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
 * // returns [...]
 */
 declare function datespace( start: Date | number | string, stop: Date | number | string, options?: Options ): Array<Date>;
@@ -81,7 +81,7 @@ declare function datespace( start: Date | number | string, stop: Date | number |
 * // returns [...]
 *
 * // Equivalent of Math.round():
-* var arr = datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
+* arr = datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
 * // returns [...]
 */
 declare function datespace( start: Date | number | string, stop: Date | number | string, length: number, options?: Options ): Array<Date>;

lib/node_modules/@stdlib/array/docs/types/index.d.ts

@@ -490,7 +490,7 @@ interface Namespace {
 	* // returns [...]
 	*
 	* // Equivalent of Math.round():
-	* var arr = ns.datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
+	* arr = ns.datespace( 1417503655000, 1417503655001, 3, { 'round': 'round' } );
 	* // returns [...]
 	*/
 	datespace: typeof datespace;
@@ -520,7 +520,7 @@ interface Namespace {
 	* var dt = ns.dtype( [ 1, 2, 3 ] );
 	* // returns 'generic'
 	*
-	* var dt = ns.dtype( 'beep' );
+	* dt = ns.dtype( 'beep' );
 	* // returns null
 	*/
 	dtype: typeof dtype;

lib/node_modules/@stdlib/array/dtype/docs/types/index.d.ts

@@ -214,7 +214,7 @@
 * var dt = dtype( [ 1, 2, 3 ] );
 * // returns 'generic'
 */
 declare function dtype( value: Array<any> ): 'generic';
 
 /**
 * Returns the data type of an array.
@@ -230,10 +230,10 @@
 * var dt = dtype( [ 1, 2, 3 ] );
 * // returns 'generic'
 *
-* var dt = dtype( 'beep' );
+* dt = dtype( 'beep' );
 * // returns null
 */
 declare function dtype( value: Array<any> | RealOrComplexTypedArray ): DataType | null;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/assert/docs/types/index.d.ts

@@ -4619,7 +4619,7 @@ interface Namespace {
 	* var bool = ns.isMethod( beep, 'boop' );
 	* // returns true
 	*
-	* var bool = ns.isMethod( beep, 'toString' );
+	* bool = ns.isMethod( beep, 'toString' );
 	* // returns false
 	*/
 	isMethod: typeof isMethod;

lib/node_modules/@stdlib/assert/is-method/docs/types/index.d.ts

@@ -39,10 +39,10 @@
 * var bool = isMethod( beep, 'boop' );
 * // returns true
 *
-* var bool = isMethod( beep, 'toString' );
+* bool = isMethod( beep, 'toString' );
 * // returns false
 */
 declare function isMethod( value: any, property: any ): boolean;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/complex/docs/types/index.d.ts

@@ -85,7 +85,7 @@ interface Namespace {
 	* var dt = ns.dtype( new Complex64( 1.0, 2.0 ) );
 	* // returns 'complex64'
 	*
-	* var dt = ns.dtype( 'beep' );
+	* dt = ns.dtype( 'beep' );
 	* // returns null
 	*/
 	dtype: typeof dtype;

lib/node_modules/@stdlib/complex/dtype/docs/types/index.d.ts

@@ -71,10 +71,10 @@
 * var dt = dtype( new Complex64( 1.0, 2.0 ) );
 * // returns 'complex64'
 *
-* var dt = dtype( 'beep' );
+* dt = dtype( 'beep' );
 * // returns null
 */
 declare function dtype( value: any ): DataType | null;
 
 
 // EXPORTS //

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

@@ -7359,7 +7359,7 @@ interface Namespace {
 	* var v = ns.minmax( 3.14, 4.2 );
 	* // returns [ 3.14, 4.2 ]
 	*
-	* var v = ns.minmax( 3.14, NaN );
+	* v = ns.minmax( 3.14, NaN );
 	* // returns [ NaN, NaN ]
 	*
 	* @example
@@ -7443,7 +7443,7 @@ interface Namespace {
 	* var v = ns.minmaxf( 3.14, 4.2 );
 	* // returns [ 3.14, 4.2 ]
 	*
-	* var v = ns.minmaxf( 3.14, NaN );
+	* v = ns.minmaxf( 3.14, NaN );
 	* // returns [ NaN, NaN ]
 	*
 	* @example
@@ -7464,7 +7464,7 @@ interface Namespace {
 	* var v = ns.minmaxn( 3.14, 4.2 );
 	* // returns [ 3.14, 4.2 ]
 	*
-	* var v = ns.minmaxn( 3.14, NaN );
+	* v = ns.minmaxn( 3.14, NaN );
 	* // returns [ NaN, NaN ]
 	*
 	* @example

lib/node_modules/@stdlib/math/base/special/ellipe/src/main.c

@@ -303,7 +303,7 @@ static double poly_p12( const double x ) {
 /**
 * Computes the complete elliptic integral of the second kind.
 *
-* @param x    input value
+* @param m    input value
 * @return     output value
 *
 * @example

lib/node_modules/@stdlib/math/base/special/ellipk/src/main.c

@@ -331,7 +331,7 @@ static double poly_p12( const double x ) {
 * -   Fukushima, Toshio. 2009. "Fast computation of complete elliptic integrals and Jacobian elliptic functions." _Celestial Mechanics and Dynamical Astronomy_ 105 (4): 305. doi:[10.1007/s10569-009-9228-z](https://doi.org/10.1007/s10569-009-9228-z).
 * -   Fukushima, Toshio. 2015. "Precise and fast computation of complete elliptic integrals by piecewise minimax rational function approximation." _Journal of Computational and Applied Mathematics_ 282 (July): 71–76. doi:[10.1016/j.cam.2014.12.038](https://doi.org/10.1016/j.cam.2014.12.038).
 *
-* @param x    input value
+* @param m    input value
 * @return     output value
 *
 * @example

lib/node_modules/@stdlib/math/base/special/gammainc/src/main.c

@@ -418,7 +418,7 @@ static double sumSeries1( const double a, const double z, const double initialVa
 *
 * @param a                 function parameter
 * @param z                 function parameter
-* @param initialValue      initial value of the resulting sum
+* @param initValue         initial value of the resulting sum
 * @returns                 sum of terms of lower gamma series
 */
 static double lowerGammaSeries( const double a, const double z, const double initValue ) {

lib/node_modules/@stdlib/math/base/special/logit/src/main.c

@@ -27,7 +27,7 @@
 /**
 * Evaluates the logit function.
 *
-* @param x    input value
+* @param p    input value
 * @return     output value
 *
 * @example

lib/node_modules/@stdlib/math/base/special/logitf/src/main.c

@@ -26,7 +26,7 @@
 /**
 * Computes the logit function for a single-precision floating-point number.
 *
-* @param x    input value
+* @param p    input value
 * @return     output value
 *
 * @example

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

@@ -28,10 +28,10 @@
 * var dt = dtype( [ 1, 2, 3 ] );
 * // returns 'generic'
 *
-* var dt = dtype( 'beep' );
+* dt = dtype( 'beep' );
 * // returns null
 */
 declare function dtype( value: any ): string | null; // FIXME: add support for `Struct` constructors
 
 
 // EXPORTS //

lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts

@@ -1183,7 +1183,7 @@ interface Namespace {
 	* var dt = ns.bufferDataType( [ 1, 2, 3 ] );
 	* // returns 'generic'
 	*
-	* var dt = ns.bufferDataType( 'beep' );
+	* dt = ns.bufferDataType( 'beep' );
 	* // returns null
 	*/
 	bufferDataType: typeof bufferDataType;

lib/node_modules/@stdlib/random/base/shared/src/main.c

@@ -160,9 +160,9 @@ void * stdlib_base_prng_state( const struct BasePRNGObject *obj ) {
 *
 * -   The function returns `-1` if unable to set a PRNG state and `0` otherwise.
 *
-* @param obj    PRNG object
-* @param state  state
-* @return       status code
+* @param obj     PRNG object
+* @param vstate  state
+* @return        status code
 */
 int8_t stdlib_base_prng_set( struct BasePRNGObject *obj, const void *vstate ) {
 	if ( obj == NULL || vstate == NULL ) {

lib/node_modules/@stdlib/stats/base/dists/betaprime/cdf/docs/types/index.d.ts

@@ -120,7 +120,7 @@ interface CDF {
 *
 * var myCDF = cdf.factory( 0.5, 0.5 );
 *
-* var y = myCDF( 0.8 );
+* y = myCDF( 0.8 );
 * // returns ~0.465
 *
 * y = myCDF( 0.3 );

lib/node_modules/@stdlib/stats/base/dists/betaprime/docs/types/index.d.ts

@@ -54,7 +54,7 @@ interface Namespace {
 	*
 	* var myCDF = ns.cdf.factory( 0.5, 0.5 );
 	*
-	* var y = myCDF( 0.8 );
+	* y = myCDF( 0.8 );
 	* // returns ~0.465
 	*
 	* y = myCDF( 0.3 );
@@ -129,7 +129,7 @@ interface Namespace {
 	*
 	* var mylogcdf = ns.logcdf.factory( 0.5, 0.5 );
 	*
-	* var y = mylogcdf( 0.8 );
+	* y = mylogcdf( 0.8 );
 	* // returns ~-0.767
 	*
 	* y = mylogcdf( 0.3 );
@@ -154,7 +154,7 @@ interface Namespace {
 	*
 	* var mylogpdf = ns.logpdf.factory( 0.5, 0.5 );
 	*
-	* var y = mylogpdf( 0.8 );
+	* y = mylogpdf( 0.8 );
 	* // returns ~-1.62
 	*
 	* y = mylogpdf( 0.3 );
@@ -269,7 +269,7 @@ interface Namespace {
 	*
 	* var mypdf = ns.pdf.factory( 0.5, 0.5 );
 	*
-	* var y = mypdf( 0.8 );
+	* y = mypdf( 0.8 );
 	* // returns ~0.198
 	*
 	* y = mypdf( 0.3 );
@@ -294,7 +294,7 @@ interface Namespace {
 	*
 	* var myQuantile = ns.quantile.factory( 2.0, 2.0 );
 	*
-	* var y = myQuantile( 0.8 );
+	* y = myQuantile( 0.8 );
 	* // returns ~2.483
 	*
 	* y = myQuantile( 0.4 );

lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/docs/types/index.d.ts

@@ -120,7 +120,7 @@ interface LogCDF {
 *
 * var mylogcdf = logcdf.factory( 0.5, 0.5 );
 *
-* var y = mylogcdf( 0.8 );
+* y = mylogcdf( 0.8 );
 * // returns ~-0.767
 *
 * y = mylogcdf( 0.3 );

lib/node_modules/@stdlib/stats/base/dists/betaprime/logpdf/docs/types/index.d.ts

@@ -120,7 +120,7 @@ interface LogPDF {
 *
 * var mylogpdf = logpdf.factory( 0.5, 0.5 );
 *
-* var y = mylogpdf( 0.8 );
+* y = mylogpdf( 0.8 );
 * // returns ~-1.62
 *
 * y = mylogpdf( 0.3 );

lib/node_modules/@stdlib/stats/base/dists/betaprime/pdf/docs/types/index.d.ts

@@ -120,7 +120,7 @@ interface PDF {
 *
 * var mypdf = pdf.factory( 0.5, 0.5 );
 *
-* var y = mypdf( 0.8 );
+* y = mypdf( 0.8 );
 * // returns ~0.198
 *
 * y = mypdf( 0.3 );

lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/docs/types/index.d.ts

@@ -120,7 +120,7 @@ interface Quantile {
 *
 * var myQuantile = quantile.factory( 2.0, 2.0 );
 *
-* var y = myQuantile( 0.8 );
+* y = myQuantile( 0.8 );
 * // returns ~2.483
 *
 * y = myQuantile( 0.4 );

lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/docs/types/index.d.ts

@@ -102,7 +102,7 @@ interface CDF {
 *
 * var mycdf = cdf.factory( 1.0 );
 *
-* var y = mycdf( 2.0 );
+* y = mycdf( 2.0 );
 * // returns ~0.843
 *
 * y = mycdf( 1.2 );

lib/node_modules/@stdlib/stats/base/dists/chisquare/docs/types/index.d.ts

@@ -55,7 +55,7 @@ interface Namespace {
 	*
 	* var mycdf = ns.cdf.factory( 1.0 );
 	*
-	* var y = mycdf( 2.0 );
+	* y = mycdf( 2.0 );
 	* // returns ~0.843
 	*
 	* y = mycdf( 1.2 );

lib/node_modules/@stdlib/stats/base/dists/gamma/docs/types/index.d.ts

@@ -163,7 +163,7 @@ interface Namespace {
 	* // returns ~-0.047
 	*
 	* var mylogcdf = ns.logcdf.factory( 3.0, 1.5 );
-	* var y = mylogcdf( 1.0 );
+	* y = mylogcdf( 1.0 );
 	* // returns ~-1.655
 	*/
 	logcdf: typeof logcdf;
@@ -181,7 +181,7 @@ interface Namespace {
 	* // returns ~-2.919
 	*
 	* var mylogpdf = ns.logpdf.factory( 6.0, 7.0 );
-	* var y = mylogpdf( 2.0 );
+	* y = mylogpdf( 2.0 );
 	* // returns ~-3.646
 	*/
 	logpdf: typeof logpdf;

lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/types/index.d.ts

@@ -110,7 +110,7 @@ interface LogCDF {
 * // returns ~-0.047
 *
 * var mylogcdf = logcdf.factory( 3.0, 1.5 );
-* var y = mylogcdf( 1.0 );
+* y = mylogcdf( 1.0 );
 * // returns ~-1.655
 */
 declare var logcdf: LogCDF;

lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/types/index.d.ts

@@ -110,7 +110,7 @@ interface LogPDF {
 * // returns ~-2.919
 *
 * var mylogpdf = logpdf.factory( 6.0, 7.0 );
-* var y = mylogpdf( 2.0 );
+* y = mylogpdf( 2.0 );
 * // returns ~-3.646
 */
 declare var logpdf: LogPDF;

lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/types/index.d.ts

@@ -95,7 +95,7 @@ interface LogPDF {
 * // returns ~-0.546
 *
 * var mylogpdf = logpdf.factory( 1.0 );
-* var y = mylogpdf( 0.8 );
+* y = mylogpdf( 0.8 );
 * // returns ~-0.546
 */
 declare var logpdf: LogPDF;

lib/node_modules/@stdlib/stats/base/dists/levy/docs/types/index.d.ts

@@ -118,7 +118,7 @@ interface Namespace {
 	* // returns ~-6.4596
 	*
 	* var mylogcdf = ns.logcdf.factory( 2.0, 3.0 );
-	* var y = mylogcdf( 100.0 );
+	* y = mylogcdf( 100.0 );
 	* // returns ~-0.15
 	*
 	* y = mylogcdf( 10.0 );

lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/docs/types/index.d.ts

@@ -108,7 +108,7 @@ interface LogCDF {
 * // returns ~-6.4596
 *
 * var mylogcdf = logcdf.factory( 2.0, 3.0 );
-* var y = mylogcdf( 100.0 );
+* y = mylogcdf( 100.0 );
 * // returns ~-0.15
 *
 * y = mylogcdf( 10.0 );

lib/node_modules/@stdlib/stats/base/dists/signrank/cdf/docs/types/index.d.ts

@@ -101,7 +101,7 @@ interface CDF {
 * // returns ~0.037
 *
 * var mycdf = cdf.factory( 8 );
-* var y = mycdf( 3.9 );
+* y = mycdf( 3.9 );
 * // returns ~0.027
 */
 declare var cdf: CDF;

lib/node_modules/@stdlib/stats/base/dists/signrank/docs/types/index.d.ts

@@ -40,7 +40,7 @@ interface Namespace {
 	* // returns ~0.037
 	*
 	* var mycdf = ns.cdf.factory( 8 );
-	* var y = mycdf( 3.9 );
+	* y = mycdf( 3.9 );
 	* // returns ~0.027
 	*/
 	cdf: typeof cdf;
@@ -57,7 +57,7 @@ interface Namespace {
 	* // returns ~0.01
 	*
 	* var mypdf = ns.pdf.factory( 8 );
-	* var y = mypdf( 4.0 );
+	* y = mypdf( 4.0 );
 	* // returns ~0.008
 	*/
 	pdf: typeof pdf;

lib/node_modules/@stdlib/stats/base/dists/signrank/pdf/docs/types/index.d.ts

@@ -101,7 +101,7 @@ interface PDF {
 * // returns ~0.01
 *
 * var mypdf = pdf.factory( 8 );
-* var y = mypdf( 4.0 );
+* y = mypdf( 4.0 );
 * // returns ~0.008
 */
 declare var pdf: PDF;