Skip to content

Commit 58e26cb

Browse files
committed
chore: fix parameter names, return annotations, and example code
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 8ad374c commit 58e26cb

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed

lib/node_modules/@stdlib/math/base/special/betaln/include/stdlib/math/base/special/betaln.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extern "C" {
2929
/**
3030
* Evaluates the natural logarithm of the beta function.
3131
*/
32-
double stdlib_base_betaln( const double x, const double y );
32+
double stdlib_base_betaln( const double a, const double b );
3333

3434
#ifdef __cplusplus
3535
}

lib/node_modules/@stdlib/math/base/special/betaln/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ static const double XMAX = 3.745194030963158e306;
6666
* - Fox, Leslie, and Ian Bax Parker. 1968. _Chebyshev polynomials in numerical analysis_. Oxford Mathematical Handbooks. London, United Kingdom: Oxford University Press. <https://books.google.com/books?id=F8NzsEtJCD0C>.
6767
*
6868
* @param x value at which the series is to be evaluated
69-
* @returns series value
69+
* @return series value
7070
*/
7171
static double dceval( const double x ) {
7272
double twox;
@@ -119,7 +119,7 @@ static double gammaCorrection( const double x ) {
119119
*
120120
* @param a first input value
121121
* @param b second input value
122-
* @returns natural logarithm of beta function
122+
* @return natural logarithm of beta function
123123
*
124124
* @example
125125
* double out = stdlib_base_betaln( 5.0, 0.2 );

lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ static const double FACTORIAL_169 = 4.269068009004705e+304;
6464
*
6565
* @param z first gamma parameter
6666
* @param delta difference
67-
* @returns gamma ratio
67+
* @return gamma ratio
6868
*/
6969
static double gammaDeltaRatioLanczos( const double z, const double delta ) {
7070
double result;

lib/node_modules/@stdlib/math/base/special/gammaln/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ static double polyval_w( const double x ) {
396396
* ```
397397
*
398398
* @param x input value
399-
* @returns function value
399+
* @return function value
400400
*
401401
* @example
402402
* double out = stdlib_base_gammaln( 1.0 );

lib/node_modules/@stdlib/stats/base/dists/triangular/mean/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
* @param a minimum support
2626
* @param b maximum support
2727
* @param c mode
28-
* @returns expected value
28+
* @return expected value
2929
*
3030
* @example
31-
* double v = mean( 0.0, 10.0, 5.0 );
31+
* double v = stdlib_base_dists_triangular_mean( 0.0, 10.0, 5.0 );
3232
* // returns 5.0
3333
*/
3434
double stdlib_base_dists_triangular_mean( const double a, const double b, const double c ) {

lib/node_modules/@stdlib/stats/base/dists/triangular/mode/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
* @param a minimum support
2626
* @param b maximum support
2727
* @param c mode
28-
* @returns mode
28+
* @return mode
2929
*
3030
* @example
31-
* double v = mode( 0.0, 10.0, 5.0 );
31+
* double v = stdlib_base_dists_triangular_mode( 0.0, 10.0, 5.0 );
3232
* // returns 5.0
3333
*/
3434
double stdlib_base_dists_triangular_mode( const double a, const double b, const double c ) {

lib/node_modules/@stdlib/stats/base/dists/weibull/mean/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
*
2626
* @param k shape parameter
2727
* @param lambda scale parameter
28-
* @returns expected value
28+
* @return expected value
2929
*
3030
* @example
31-
* double v = mean( 1.0, 1.0 );
31+
* double v = stdlib_base_dists_weibull_mean( 1.0, 1.0 );
3232
* // returns 1.0
3333
*/
3434
double stdlib_base_dists_weibull_mean( const double k, const double lambda ) {

0 commit comments

Comments
 (0)