Skip to content

Commit 7024fdc

Browse files
committed
chore: apply suggestions
If applied, this commit will fix documentation comment in main.c spacing issues in median.h fix parameter description in native.js comment --- 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: passed - 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: missing_dependencies - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 9d68af0 commit 7024fdc

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

  • lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/include/stdlib/stats/base/dists/pareto-type1/median.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ double stdlib_base_dists_pareto_type1_median( const double alpha, const double b
3535
}
3636
#endif
3737

38-
#endif //!STDLIB_STATS_BASE_DISTS_PARETO_TYPE1_MEDIAN_H
38+
#endif // !STDLIB_STATS_BASE_DISTS_PARETO_TYPE1_MEDIAN_H

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/lib/native.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ var addon = require( './../src/addon.node' );
2929
* Returns the median of a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta`.
3030
*
3131
* @private
32-
* @param {number} alpha - shape parameter
33-
* @param {number} beta - scale parameter
32+
* @param {PositiveNumber} alpha - shape parameter
33+
* @param {PositiveNumber} beta - scale parameter
3434
* @returns {number} median
3535
*
3636
* @example

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/src/main.c

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
#include "stdlib/math/base/special/pow.h"
2222

2323
/**
24-
* Evaluates the median for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta`.
25-
*
26-
* @param alpha - shape parameter
27-
* @param beta - scale parameter
28-
* @returns evaluated median
29-
*
30-
* @example
31-
* double y = stdlib_base_dists_pareto_type1_median( 4.0, 12.0 )
32-
* //returns ~14.27
24+
* Evaluates the median for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta`.
25+
*
26+
* @param alpha shape parameter
27+
* @param beta scale parameter
28+
* @return median
29+
*
30+
* @example
31+
* double y = stdlib_base_dists_pareto_type1_median( 4.0, 12.0 );
32+
* // returns ~14.27
3333
*/
3434
double stdlib_base_dists_pareto_type1_median( const double alpha, const double beta ) {
3535
if (
@@ -38,7 +38,7 @@ double stdlib_base_dists_pareto_type1_median( const double alpha, const double b
3838
alpha <= 0.0 ||
3939
beta <= 0.0
4040
) {
41-
return 0.0/0.0; //NaN
41+
return 0.0/0.0; // NaN
4242
}
43-
return beta * stdlib_base_pow( 2.0 , 1.0/alpha );
43+
return beta * stdlib_base_pow( 2.0, 1.0 / alpha );
4444
}

0 commit comments

Comments
 (0)