Auto-generated commit

stdlib-js · Dec 29, 2024 · f1aea64 · f1aea64
1 parent 3879912
commit f1aea64
Show file tree

Hide file tree

Showing 13 changed files with 52 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-24)
+## Unreleased (2024-12-29)
 
 <section class="packages">
 
@@ -121,6 +121,7 @@ A total of 2 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`b87254d`](https://github.com/stdlib-js/stdlib/commit/b87254d4535a3b90bf3d0068750ed6e9ca5dbc85) - **docs:** fix parameter descriptions in Weibull distribution packages _(by Philipp Burckhardt)_
 -   [`90e96d0`](https://github.com/stdlib-js/stdlib/commit/90e96d01b7a32ec3b71caf3e5f57528338199a8f) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`8553770`](https://github.com/stdlib-js/stdlib/commit/85537708442675d6bc1bf5dad5aaf252cecb82ac) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`32deb11`](https://github.com/stdlib-js/stdlib/commit/32deb11c6a2453748d8db9554b6bb3fdb73a077f) - **docs:** update related packages sections [(#3976)](https://github.com/stdlib-js/stdlib/pull/3976) _(by stdlib-bot)_

diff --git a/array/docs/types/index.d.ts b/array/docs/types/index.d.ts
@@ -821,8 +821,8 @@ interface Namespace {
 	* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
 	*
 	* @param len - array length
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @returns output array
 	*

diff --git a/array/weibull/docs/types/index.d.ts b/array/weibull/docs/types/index.d.ts
@@ -138,8 +138,8 @@ interface TernaryFunction extends PRNG {
 	* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
 	*
 	* @param len - array length
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @returns output array
 	*/
@@ -148,8 +148,8 @@ interface TernaryFunction extends PRNG {
 	/**
 	* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param out - output array
 	* @returns output array
 	*/
@@ -164,8 +164,8 @@ interface Random extends PRNG {
 	* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
 	*
 	* @param len - array length
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @returns output array
 	*
@@ -178,8 +178,8 @@ interface Random extends PRNG {
 	/**
 	* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param out - output array
 	* @returns output array
 	*
@@ -204,8 +204,8 @@ interface Random extends PRNG {
 	*
 	* -   When provided distribution parameters, the returned function returns random variates drawn from the specified distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @throws must provide a valid state
 	* @returns function for creating arrays
@@ -256,8 +256,8 @@ interface Random extends PRNG {
 * Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
 *
 * @param len - array length
-* @param k - scale parameter
-* @param lambda - shape parameter
+* @param k - shape parameter
+* @param lambda - scale parameter
 * @param options - function options
 * @returns output array
 *

diff --git a/array/weibull/lib/main.js b/array/weibull/lib/main.js
@@ -31,8 +31,8 @@ var factory = require( './factory.js' );
 * @name weibull
 * @type {Function}
 * @param {NonNegativeInteger} len - array length
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @param {Options} [options] - options
 * @param {string} [options.dtype="float64"] - output array data type
 * @throws {TypeError} first argument must be a nonnegative integer

diff --git a/base/docs/types/index.d.ts b/base/docs/types/index.d.ts
@@ -1017,8 +1017,8 @@ interface Namespace {
 	* -   If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
 	* -   If `k` or `lambda` is `NaN`, the function returns `NaN`.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @returns pseudorandom number
 	*
 	* @example

diff --git a/base/weibull/docs/types/index.d.ts b/base/weibull/docs/types/index.d.ts
@@ -113,8 +113,8 @@ interface BinaryFunction extends PRNG {
 	/**
 	* Returns a Weibull distributed pseudorandom number.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @returns pseudorandom number
 	*/
 	( k: number, lambda: number ): number;
@@ -132,8 +132,8 @@ interface Random extends PRNG {
 	* -   If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
 	* -   If `k` or `lambda` is `NaN`, the function returns `NaN`.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @returns pseudorandom number
 	*
 	* @example
@@ -149,8 +149,8 @@ interface Random extends PRNG {
 	*
 	* -   When provided `k` and `lambda`, the returned PRNG returns random variates drawn from the specified distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
 	* @param options.seed - pseudorandom number generator seed
@@ -213,8 +213,8 @@ interface Random extends PRNG {
 * -   If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
 * -   If `k` or `lambda` is `NaN`, the function returns `NaN`.
 *
-* @param k - scale parameter
-* @param lambda - shape parameter
+* @param k - shape parameter
+* @param lambda - scale parameter
 * @returns pseudorandom number
 *
 * @example

diff --git a/base/weibull/lib/main.js b/base/weibull/lib/main.js
@@ -30,8 +30,8 @@ var factory = require( './factory.js' );
 *
 * @name weibull
 * @type {PRNG}
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {NonNegativeNumber} pseudorandom number
 *
 * @example

diff --git a/base/weibull/lib/validate.js b/base/weibull/lib/validate.js
@@ -30,8 +30,8 @@ var format = require( '@stdlib/string/format' );
 * Validates parameters.
 *
 * @private
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {(Error|null)} error or null
 *
 * @example

diff --git a/base/weibull/lib/weibull.js b/base/weibull/lib/weibull.js
@@ -31,8 +31,8 @@ var ln = require( '@stdlib/math/base/special/ln' );
 *
 * @private
 * @param {PRNG} rand - PRNG for generating uniformly distributed numbers
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {NonNegativeNumber} pseudorandom number
 */
 function weibull( rand, k, lambda ) {

diff --git a/streams/docs/types/index.d.ts b/streams/docs/types/index.d.ts
@@ -3641,8 +3641,8 @@ interface Namespace {
 	/**
 	* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @throws `k` must be a positive number
 	* @throws `lambda` must be a positive number

diff --git a/streams/weibull/docs/types/index.d.ts b/streams/weibull/docs/types/index.d.ts
@@ -86,8 +86,8 @@ declare class RandomStream extends Readable {
 	/**
 	* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @throws `k` must be a positive number
 	* @throws `lambda` must be a positive number
@@ -207,8 +207,8 @@ interface Constructor {
 	/**
 	* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @throws `k` must be a positive number
 	* @throws `lambda` must be a positive number
@@ -236,8 +236,8 @@ interface Constructor {
 	/**
 	* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @throws `k` must be a positive number
 	* @throws `lambda` must be a positive number
@@ -265,8 +265,8 @@ interface Constructor {
 	/**
 	* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @returns factory function
 	*
@@ -317,8 +317,8 @@ interface Constructor {
 	/**
 	* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - stream options
 	* @throws `k` must be a positive number
 	* @throws `lambda` must be a positive number
@@ -347,8 +347,8 @@ interface Constructor {
 /**
 * Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 *
-* @param k - scale parameter
-* @param lambda - shape parameter
+* @param k - shape parameter
+* @param lambda - scale parameter
 * @param options - stream options
 * @throws `k` must be a positive number
 * @throws `lambda` must be a positive number

diff --git a/streams/weibull/lib/main.js b/streams/weibull/lib/main.js
@@ -189,8 +189,8 @@ function destroy( error ) {
 * Stream constructor for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
 *
 * @constructor
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @param {Options} [options] - stream options
 * @param {boolean} [options.objectMode=false] - specifies whether the stream should operate in object mode
 * @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to strings

diff --git a/streams/weibull/lib/object_mode.js b/streams/weibull/lib/object_mode.js
@@ -31,8 +31,8 @@ var RandomStream = require( './main.js' );
 /**
 * Returns an "objectMode" readable stream for generating pseudorandom numbers drawn from a Weibull distribution.
 *
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @param {Options} [options] - stream options
 * @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to `strings`
 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of objects to store in an internal buffer before ceasing to generate additional pseudorandom numbers