Auto-generated commit

stdlib-js · Dec 29, 2024 · 0a936e5 · 0a936e5
1 parent 200340c
commit 0a936e5
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`b87254d`](https://github.com/stdlib-js/stdlib/commit/b87254d4535a3b90bf3d0068750ed6e9ca5dbc85) - **docs:** fix parameter descriptions in Weibull distribution packages _(by Philipp Burckhardt)_
 -   [`f9f468e`](https://github.com/stdlib-js/stdlib/commit/f9f468e240d7e5b5d155279e4386b8b606cd8227) - **feat:** add C implementation of `stats/base/dists/weibull/cdf` _(by Vinit Pandit, Philipp Burckhardt)_
 
 </details>

diff --git a/README.md b/README.md
@@ -222,8 +222,8 @@ double out = stdlib_base_dists_weibull_cdf( 2.0, 1.0, 1.0 );
 The function accepts the following arguments:
 
 -   **x**: `[in] double` input value.
--   **k**: `[in] double` scale parameter.
--   **lambda**: `[in] double` shape parameter.
+-   **k**: `[in] double` shape parameter.
+-   **lambda**: `[in] double` scale parameter.
 
 ```c
 double stdlib_base_dists_weibull_cdf( const double x, const double k, const double lambda );

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts
@@ -38,8 +38,8 @@ interface CDF {
 	* -   If provided a non-positive value for `lambda` or `k`, the function returns `NaN`.
 	*
 	* @param x - input value
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @returns evaluated CDF
 	*
 	* @example
@@ -79,8 +79,8 @@ interface CDF {
 	/**
 	* Returns a function for evaluating the cumulative distribution function (CDF) for a Weibull distribution.
 	*
-	* @param k - scale parameter
-	* @param lambda - shape parameter
+	* @param k - shape parameter
+	* @param lambda - scale parameter
 	* @returns CDF
 	*
 	* @example
@@ -98,8 +98,8 @@ interface CDF {
 * Weibull distribution cumulative distribution function (CDF).
 *
 * @param x - input value
-* @param k - scale parameter
-* @param lambda - shape parameter
+* @param k - shape parameter
+* @param lambda - scale parameter
 * @returns evaluated CDF
 *
 * @example

diff --git a/lib/factory.js b/lib/factory.js
@@ -31,8 +31,8 @@ var pow = require( '@stdlib/math-base-special-pow' );
 /**
 * Returns a function for evaluating the cumulative distribution function (CDF) for a Weibull distribution.
 *
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {Function} CDF
 *
 * @example

diff --git a/lib/main.js b/lib/main.js
@@ -31,8 +31,8 @@ var pow = require( '@stdlib/math-base-special-pow' );
 * Evaluates the cumulative distribution function (CDF) for a Weibull distribution with scale parameter `k` and shape parameter `lambda` at a value `x`.
 *
 * @param {number} x - input value
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {Probability} evaluated CDF
 *
 * @example

diff --git a/lib/native.js b/lib/native.js
@@ -30,8 +30,8 @@ var addon = require( './../src/addon.node' );
 *
 * @private
 * @param {number} x - input value
-* @param {PositiveNumber} k - scale parameter
-* @param {PositiveNumber} lambda - shape parameter
+* @param {PositiveNumber} k - shape parameter
+* @param {PositiveNumber} lambda - scale parameter
 * @returns {Probability} evaluated CDF
 *
 * @example

diff --git a/src/main.c b/src/main.c
@@ -25,8 +25,8 @@
 * Evaluates the cumulative distribution function (CDF) for a Weibull distribution with scale parameter `k` and shape parameter `lambda` at a value `x`.
 *
 * @param x         input value
-* @param k    	   scale parameter
-* @param lambda    shape parameter
+* @param k    	   shape parameter
+* @param lambda    scale parameter
 * @return          evaluated CDF
 *
 * @example