From 38a604780563d434371ba646dbbc463530be790d Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 27 Jul 2023 10:39:53 -0400 Subject: [PATCH] docs: update JSDoc comment formatting --- .../math/base/ops/imul/lib/polyfill.js | 1 - .../@stdlib/math/base/ops/umul/lib/main.js | 1 - .../@stdlib/math/base/special/cot/lib/main.js | 50 +++++++++---------- .../@stdlib/os/homedir/lib/index.js | 2 +- .../stats/incr/mcovariance/lib/main.js | 1 - .../@stdlib/stats/incr/meanstdev/lib/main.js | 1 - .../@stdlib/stats/incr/meanvar/lib/main.js | 1 - .../@stdlib/stats/incr/mpcorr/lib/main.js | 1 - .../@stdlib/stats/incr/mpcorrdist/lib/main.js | 1 - .../@stdlib/stats/incr/mprod/lib/main.js | 1 - .../@stdlib/stats/incr/prod/lib/main.js | 1 - .../@stdlib/stats/incr/skewness/lib/main.js | 1 - 12 files changed, 26 insertions(+), 36 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js b/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js index a76ac1f0687..c62a079ac9a 100644 --- a/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js +++ b/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js @@ -91,7 +91,6 @@ var LOW_WORD_MASK = 0x0000ffff>>>0; // asm type annotation * * - Lastly, the second term in the above equation contributes to the middle bits and may cause the product to "overflow". However, we can disregard (`>>>0`) overflow bits due to modulo arithmetic, as discussed earlier with regard to the term involving the partial product of high words. * -* * @param {integer32} a - integer * @param {integer32} b - integer * @returns {integer32} product diff --git a/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js b/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js index c7127c154f7..ec2bb94aa1b 100644 --- a/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js @@ -91,7 +91,6 @@ var LOW_WORD_MASK = 0x0000ffff>>>0; // asm type annotation * * - Lastly, the second term in the above equation contributes to the middle bits and may cause the product to "overflow". However, we can disregard (`>>>0`) overflow bits due to modulo arithmetic, as discussed earlier with regard to the term involving the partial product of high words. * -* * @param {uinteger32} a - integer * @param {uinteger32} b - integer * @returns {uinteger32} product diff --git a/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js index 4c0f768f549..d5953e5e804 100644 --- a/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js @@ -26,31 +26,31 @@ var tan = require( '@stdlib/math/base/special/tan' ); // MAIN // /** - * Evaluates the cotangent of a number. - * - * @param {number} x - input value (in radians) - * @returns {number} cotangent - * - * @example - * var v = cot( 0.0 ); - * // returns Infinity - * - * @example - * var v = cot( 3.141592653589793/2.0 ); - * // returns ~0.0 - * - * @example - * var v = cot( -3.141592653589793/4.0 ); - * // returns ~-1.0 - * - * @example - * var v = cot( 3.141592653589793/4.0 ); - * // returns ~1.0 - * - * @example - * var v = cot( NaN ); - * // returns NaN - */ +* Evaluates the cotangent of a number. +* +* @param {number} x - input value (in radians) +* @returns {number} cotangent +* +* @example +* var v = cot( 0.0 ); +* // returns Infinity +* +* @example +* var v = cot( 3.141592653589793/2.0 ); +* // returns ~0.0 +* +* @example +* var v = cot( -3.141592653589793/4.0 ); +* // returns ~-1.0 +* +* @example +* var v = cot( 3.141592653589793/4.0 ); +* // returns ~1.0 +* +* @example +* var v = cot( NaN ); +* // returns NaN +*/ function cot( x ) { return 1.0 / tan( x ); } diff --git a/lib/node_modules/@stdlib/os/homedir/lib/index.js b/lib/node_modules/@stdlib/os/homedir/lib/index.js index 1880afa8d25..2968172e347 100644 --- a/lib/node_modules/@stdlib/os/homedir/lib/index.js +++ b/lib/node_modules/@stdlib/os/homedir/lib/index.js @@ -38,7 +38,7 @@ var main = require( './main.js' ); // VARIABLES // -var home = ( isFunction( os.homedir ) ) ? os.homedir : main; +var home = ( isFunction( os.homedir ) ) ? os.homedir : main; // eslint-disable-line node/no-unsupported-features/node-builtins // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js index 0775edeb94b..1e43e1f6efa 100644 --- a/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js @@ -166,7 +166,6 @@ var format = require( '@stdlib/string/format' ); * C_n = C_{n-1} + \Delta x_{N,n-1} \Delta y_{N,n-1} - \Delta x_{0,n-1} \Delta y_{0,n-1} - \frac{(\Delta x_{N,n-1} - \Delta x_{0,n-1})(\Delta y_{N,n-1} - \Delta y_{0,n-1})}{N} * ``` * -* * @param {PositiveInteger} W - window size * @param {number} [meanx] - mean value * @param {number} [meany] - mean value diff --git a/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js index b1af5d0eef0..a34ddd52170 100644 --- a/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js @@ -34,7 +34,6 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' ); * ## Method * -* * - This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let * * ```tex diff --git a/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js b/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js index f238c3cd297..7c43f861462 100644 --- a/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js @@ -32,7 +32,6 @@ var format = require( '@stdlib/string/format' ); * * ## Method * -* * - This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let * * ```tex diff --git a/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js index b119417c10f..5e8d9fc4455 100644 --- a/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js @@ -242,7 +242,6 @@ var format = require( '@stdlib/string/format' ); * * where \\(\sigma_{x,n}\\) and \\(\sigma_{y,n}\\) are the corrected sample standard deviations for \\(x\\) and \\(y\\), respectively, for a window \\(n\\). * -* * @param {PositiveInteger} W - window size * @param {number} [meanx] - mean value * @param {number} [meany] - mean value diff --git a/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js index 3ca6f61305c..868c5cf26b3 100644 --- a/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js @@ -41,7 +41,6 @@ var format = require( '@stdlib/string/format' ); * * - The implementation thus computes the sample Pearson product-moment correlation coefficient \\(r_n\\) for each window \\(n\\) and subtracts the coefficient from 1. * -* * @param {PositiveInteger} W - window size * @param {number} [meanx] - mean value * @param {number} [meany] - mean value diff --git a/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js index a31091974ad..2afa2e350c5 100644 --- a/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js @@ -71,7 +71,6 @@ function product( workspace, acc, x ) { * * While intermediate results are largely immune to overflow and not subject to underflow, this does not mean that returned results will never be zero or infinite. In fact, zero (underflow) and infinite (overflow) results may be transient (i.e., infinity followed by a finite number). * -* * ## References * * - Ueberhuber, Christoph W. 1997. _Numerical Computation 1: Methods, Software, and Analysis_. Springer-Verlag Berlin Heidelberg. doi:[10.1007/978-3-642-59118-1](https://doi.org/10.1007/978-3-642-59118-1). diff --git a/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js index 75a6345f47f..f8d9638f5db 100644 --- a/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js @@ -41,7 +41,6 @@ var PARTS = [ 0.0, 0 ]; * * While intermediate results are largely immune to overflow and not subject to underflow, this does not mean that returned results will never be zero or infinite. In fact, zero (underflow) and infinite (overflow) results may be transient (i.e., infinity followed by a finite number). * -* * ## References * * - Ueberhuber, Christoph W. 1997. _Numerical Computation 1: Methods, Software, and Analysis_. Springer-Verlag Berlin Heidelberg. doi:[10.1007/978-3-642-59118-1](https://doi.org/10.1007/978-3-642-59118-1). diff --git a/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js b/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js index 3495056ec18..c59d2f14ef4 100644 --- a/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js @@ -40,7 +40,6 @@ var pow = require( '@stdlib/math/base/special/pow' ); * * [@joanes:1998]: http://dx.doi.org/10.1111/1467-9884.00122 * -* * @returns {Function} accumulator function * * @example