Add missing throws annotations

Planeshifter · Planeshifter · commit 537819003148 · 2018-06-28T11:00:24.000+02:00
diff --git a/lib/node_modules/@stdlib/datasets/lib/datasets.js b/lib/node_modules/@stdlib/datasets/lib/datasets.js
@@ -31,6 +31,7 @@ var data = require( './data.js' );
 *
 * @param {string} name - dataset name
 * @param {Options} [options] - dataset options
+* @throws {RangeError} unsupported/unrecognized dataset name
 * @returns {*} dataset
 */
 function datasets( name ) {
diff --git a/lib/node_modules/@stdlib/datasets/sotu/lib/sotu.js b/lib/node_modules/@stdlib/datasets/sotu/lib/sotu.js
@@ -43,6 +43,7 @@ var getFile = require( './get_file.js' );
 * @param {(PositiveInteger|PositiveIntegerArray)} [options.year] - year(s)
 * @param {PositiveIntegerArray} [options.range] - year range
 * @param {(string|StringArray)} [options.party] - political party
+* @throws {RangeError} unrecognized property value
 * @returns {ObjectArray} SOTU addresses
 *
 * @example
diff --git a/lib/node_modules/@stdlib/ml/online-binary-classification/lib/weight_vector.js b/lib/node_modules/@stdlib/ml/online-binary-classification/lib/weight_vector.js
@@ -126,6 +126,8 @@ function innerProduct( x ) {
 * @constructor
 * @param {PositiveInteger} dim - number of feature weights (excluding bias/intercept term)
 * @param {boolean} intercept - boolean indicating whether a bias/intercept weight should be implicitly assumed
+* @throws {TypeError} first argument must be a positive integer
+* @throws {TypeError} second argument must be a boolean primitive
 */
 function WeightVector( dim, intercept ) {
 	var i;
diff --git a/lib/node_modules/@stdlib/ml/online-sgd-regression/lib/weight_vector.js b/lib/node_modules/@stdlib/ml/online-sgd-regression/lib/weight_vector.js
@@ -126,6 +126,8 @@ function innerProduct( x ) {
 * @constructor
 * @param {PositiveInteger} dim - number of feature weights (excluding bias/intercept term)
 * @param {boolean} intercept - boolean indicating whether a bias/intercept weight should be implicitly assumed
+* @throws {TypeError} first argument must be a positive integer
+* @throws {TypeError} second argument must be a boolean primitive
 */
 function WeightVector( dim, intercept ) {
 	var i;
diff --git a/lib/node_modules/@stdlib/stats/chi2gof/lib/get_pmf.js b/lib/node_modules/@stdlib/stats/chi2gof/lib/get_pmf.js
@@ -30,6 +30,7 @@ var PMF = require( './pmf.js' );
 *
 * @private
 * @param {string} name - distribution name
+* @throws {Error} unsupported/unrecognized distribution name
 * @returns {Function} PMF
 */
 function getPMF( name ) {
diff --git a/lib/node_modules/@stdlib/stats/lowess/lib/main.js b/lib/node_modules/@stdlib/stats/lowess/lib/main.js
@@ -59,6 +59,9 @@ function ascending( a, b ) {
 * @param {integer} [options.nsteps=3] - number of iterations in the robust fit (fewer iterations translates to faster function execution)
 * @param {NonNegativeNumber} [options.delta] - nonnegative parameter which may be used to reduce the number of computations
 * @param {boolean} [options.sorted=false] - boolean indicating if the input array `x` is already in sorted order
+* @throws {TypeError} first argument must be a numeric array
+* @throws {TypeError} second argument must be a numeric array
+* @throws {Error} arguments `x` and `y` must have the same length
 * @returns {Object} ordered x-values and fitted values
 */
 function main( x, y, options ) {
diff --git a/lib/node_modules/@stdlib/stats/pcorrtest/lib/print.js b/lib/node_modules/@stdlib/stats/pcorrtest/lib/print.js
@@ -35,6 +35,8 @@ var roundn = require( '@stdlib/math/base/special/roundn' );
 * @param {Object} [opts] - options object
 * @param {PositiveInteger} [opts.numdigits=4] - number of digits after the decimal point
 * @param {boolean} [opts.decision=true] - boolean indicating whether to print the test decision
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
 * @returns {string} formatted output
 */
 function print( opts ) { // eslint-disable-line stdlib/no-redeclare

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ var data = require( './data.js' );`
`31`	`31`	`*`
`32`	`32`	`* @param {string} name - dataset name`
`33`	`33`	`* @param {Options} [options] - dataset options`
	`34`	`+* @throws {RangeError} unsupported/unrecognized dataset name`
`34`	`35`	`* @returns {*} dataset`
`35`	`36`	`*/`
`36`	`37`	`function datasets( name ) {`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ var getFile = require( './get_file.js' );`
`43`	`43`	`* @param {(PositiveInteger\|PositiveIntegerArray)} [options.year] - year(s)`
`44`	`44`	`* @param {PositiveIntegerArray} [options.range] - year range`
`45`	`45`	`* @param {(string\|StringArray)} [options.party] - political party`
	`46`	`+* @throws {RangeError} unrecognized property value`
`46`	`47`	`* @returns {ObjectArray} SOTU addresses`
`47`	`48`	`*`
`48`	`49`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ var PMF = require( './pmf.js' );`
`30`	`30`	`*`
`31`	`31`	`* @private`
`32`	`32`	`* @param {string} name - distribution name`
	`33`	`+* @throws {Error} unsupported/unrecognized distribution name`
`33`	`34`	`* @returns {Function} PMF`
`34`	`35`	`*/`
`35`	`36`	`function getPMF( name ) {`