Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-21)
+## Unreleased (2025-12-22)
 
 <section class="features">
 
@@ -137,6 +137,7 @@ A total of 10 issues were closed in this release:
 
 <details>
 
+-   [`6260a0a`](https://github.com/stdlib-js/stdlib/commit/6260a0a2b3a065eb4660697276fe15726a64a1e2) - **docs:** correct parameter descriptions in `random/weibull` _(by Philipp Burckhardt)_
 -   [`7f63ca2`](https://github.com/stdlib-js/stdlib/commit/7f63ca2e79dfec53d1424d7c29704f0ec4cd7af7) - **bench:** reduce maximum array size _(by Athan Reines)_
 -   [`0783b86`](https://github.com/stdlib-js/stdlib/commit/0783b86b9ade65f21c5805579c3201ae0436d8d0) - **build:** reduce maximum size _(by Athan Reines)_
 -   [`4bf3633`](https://github.com/stdlib-js/stdlib/commit/4bf36333ac1de0c8bf338f0cfc98f8b305200778) - **test:** guard against edge case _(by Athan Reines)_

weibull/README.md

@@ -42,8 +42,8 @@ var arr = weibull( [ 3, 3 ], 2.0, 5.0 );
 The function has the following parameters:
 
 -   **shape**: output shape.
--   **k**: scale parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the specified output shape.
--   **lambda**: shape parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the specified output shape.
+-   **k**: shape parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the specified output shape.
+-   **lambda**: scale parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the specified output shape.
 -   **options**: function options.
 
 When provided scalar distribution parameters, every element in the output [ndarray][@stdlib/ndarray/ctor] is drawn from the same distribution. To generate pseudorandom numbers drawn from different distributions, provide distribution parameter arguments as [ndarrays][@stdlib/ndarray/ctor]. The following example demonstrates broadcasting an [ndarray][@stdlib/ndarray/ctor] containing distribution parameters to generate sub-matrices drawn from different distributions.
@@ -123,8 +123,8 @@ var bool = ( v === out );
 
 The method has the following parameters:
 
--   **k**: scale parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output [ndarray][@stdlib/ndarray/ctor].
--   **lambda**: shape parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output [ndarray][@stdlib/ndarray/ctor].
+-   **k**: shape parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output [ndarray][@stdlib/ndarray/ctor].
+-   **lambda**: scale parameter. May be either a scalar or an [ndarray][@stdlib/ndarray/ctor]. When providing an [ndarray][@stdlib/ndarray/ctor], the [ndarray][@stdlib/ndarray/ctor] must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output [ndarray][@stdlib/ndarray/ctor].
 -   **out**: output [ndarray][@stdlib/ndarray/ctor].
 
 #### weibull.factory( \[options] )

weibull/docs/repl.txt

@@ -9,11 +9,11 @@
         Array shape.
 
     k: number|ndarray
-        Scale parameter. If an ndarray, must be broadcast compatible with the
+        Shape parameter. If an ndarray, must be broadcast compatible with the
         specified array shape.
 
     lambda: number|ndarray
-        Shape parameter. If an ndarray, must be broadcast compatible with the
+        Scale parameter. If an ndarray, must be broadcast compatible with the
         specified array shape.
 
     options: Object (optional)
@@ -67,11 +67,11 @@
     Parameters
     ----------
     k: number|ndarray
-        Scale parameter. If an ndarray, must be broadcast compatible with the
+        Shape parameter. If an ndarray, must be broadcast compatible with the
         provided output array.
 
     lambda: number|ndarray
-        Shape parameter. If an ndarray, must be broadcast compatible with the
+        Scale parameter. If an ndarray, must be broadcast compatible with the
         provided output array.
 
     out: ndarray

weibull/docs/types/index.d.ts

@@ -126,8 +126,8 @@ interface RandomFunction extends PRNG {
 	* Returns an ndarray containing pseudorandom numbers drawn from a Weibull distribution.
 	*
 	* @param shape - output shape
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @throws distribution parameters and the output shape must be broadcast compatible
 	* @returns output ndarray
@@ -137,8 +137,8 @@ interface RandomFunction extends PRNG {
 	/**
 	* Fills an ndarray 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 ndarray
 	* @throws distribution parameters and the output ndarray must be broadcast compatible
 	* @returns output ndarray
@@ -154,8 +154,8 @@ interface Random extends PRNG {
 	* Returns an ndarray containing pseudorandom numbers drawn from a Weibull distribution.
 	*
 	* @param shape - output shape
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @param options - function options
 	* @throws distribution parameters and the output shape must be broadcast compatible
 	* @returns output ndarray
@@ -169,8 +169,8 @@ interface Random extends PRNG {
 	/**
 	* Fills an ndarray 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 ndarray
 	* @throws distribution parameters and the output ndarray must be broadcast compatible
 	* @returns output ndarray
@@ -216,8 +216,8 @@ interface Random extends PRNG {
 * Generates pseudorandom numbers drawn from a Weibull distribution.
 *
 * @param shape - output shape
-* @param k - scale parameter
-* @param lambda - shape parameter
+* @param k - shape parameter
+* @param lambda - scale parameter
 * @param options - function options
 * @throws distribution parameters and the output shape must be broadcast compatible
 * @returns output ndarray

weibull/lib/main.js

@@ -31,8 +31,8 @@ var factory = require( './factory.js' );
 * @name weibull
 * @type {Function}
 * @param {NonNegativeIntegerArray} shape - output ndarray shape
-* @param {(PositiveNumber|ndarrayLike)} k - scale parameter
-* @param {(PositiveNumber|ndarrayLike)} lambda - shape parameter
+* @param {(PositiveNumber|ndarrayLike)} k - shape parameter
+* @param {(PositiveNumber|ndarrayLike)} lambda - scale parameter
 * @param {Options} [options] - options
 * @param {string} [options.dtype] - output ndarray data type
 * @param {string} [options.order="row-major"] - memory layout (either row-major or column-major)