docs: resolve JSDoc errors

Planeshifter · Planeshifter · commit 81764241ec47 · 2023-07-27T12:02:29.000-04:00
diff --git a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/lib/factory.js
@@ -40,9 +40,8 @@ var JMAX = 28;
 /**
 * Returns a function for evaluating the quantile function for a studentized range distribution.
 *
-* @param {PositiveNumber} v - degrees of freedom
-* @param {number} r - sample size for range (same for each group; must be greater than or equal to `2`)
-* @param {number} v - degrees of freedom (must be greater than or equal to `2`)
+* @param {PositiveNumber} r - sample size for range (same for each group; must be greater than or equal to `2`)
+* @param {PositiveNumber} v - degrees of freedom (must be greater than or equal to `2`)
 * @param {PositiveInteger} [nranges=1] - number of groups whose maximum range is considered
 * @returns {Function} quantile function
 *
diff --git a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/lib/main.js
@@ -44,22 +44,22 @@ var JMAX = 28;
 * -   Ferreira, D. F., Demetrico, C. G. B., Manly, B. F. J., and Machado, A. de A. 2007. "Quantis da distribuição do máximo da amplitude estudentizada." _Rev. Mat. Est._, São Paulo, 25 (1): 117-135. <http://jaguar.fcav.unesp.br/RME/fasciculos/v25/v25_n1/A8_Daniel.pdf>.
 *
 * @param {Probability} p - input probability
-* @param {number} r - sample size for range (same for each group; must be greater than or equal to `2`)
-* @param {number} v - degrees of freedom (must be greater than or equal to `2`)
+* @param {PositiveNumber} r - sample size for range (same for each group; must be greater than or equal to `2`)
+* @param {PositiveNumber} v - degrees of freedom (must be greater than or equal to `2`)
 * @param {PositiveInteger} [nranges=1] - number of groups whose maximum range is considered
-* @returns evaluated quantile function
+* @returns {number} evaluated quantile function
 *
 * @example
-* var y = quantile( 0.5, 3.0, 2.0 );
-* // returns ~0.0644
+* var y = qrange( 0.5, 3.0, 2.0 );
+* // returns ~1.908
 *
 * @example
-* var y = quantile( 0.9, 17.0, 2.0 );
-* // returns ~0.913
+* var y = qrange( 0.9, 17.0, 2.0 );
+* // returns ~11.237
 *
 * @example
-* var y = quantile( 0.5, 3.0, 2.0, 2 );
-* // returns ~0.01
+* var y = qrange( 0.5, 3.0, 2.0, 2 );
+* // returns ~2.549
 */
 function qrange( p, r, v, nranges ) {
 	var aux;

Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,8 @@ var JMAX = 28;`
`40`	`40`	`/**`
`41`	`41`	`* Returns a function for evaluating the quantile function for a studentized range distribution.`
`42`	`42`	`*`
`43`		`-* @param {PositiveNumber} v - degrees of freedom`
`44`		-* @param {number} r - sample size for range (same for each group; must be greater than or equal to `2`)
`45`		-* @param {number} v - degrees of freedom (must be greater than or equal to `2`)
	`43`	+* @param {PositiveNumber} r - sample size for range (same for each group; must be greater than or equal to `2`)
	`44`	+* @param {PositiveNumber} v - degrees of freedom (must be greater than or equal to `2`)
`46`	`45`	`* @param {PositiveInteger} [nranges=1] - number of groups whose maximum range is considered`
`47`	`46`	`* @returns {Function} quantile function`
`48`	`47`	`*`