Skip to content

Commit e61b1de

Browse files
committed
docs: clean-up of C docstrings
--- 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent f505ed5 commit e61b1de

File tree

75 files changed

+74
-77
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+74
-77
lines changed

lib/node_modules/@stdlib/stats/base/dists/arcsine/cdf/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ static const double TWO_OVER_PI = 2.0 / STDLIB_CONSTANT_FLOAT64_PI;
3333
* @return evaluated CDF
3434
*
3535
* @example
36-
* double y = stdlib_base_arcsine_cdf( 9.0, 0.0, 10.0 );
36+
* double y = stdlib_base_dists_arcsine_cdf( 9.0, 0.0, 10.0 );
3737
* // returns ~0.795
3838
*/
3939
double stdlib_base_dists_arcsine_cdf( const double x, const double a, const double b ) {

lib/node_modules/@stdlib/stats/base/dists/arcsine/entropy/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* @return entropy
3030
*
3131
* @example
32-
* double y = stdlib_base_arcsine_entropy( 4.0, 12.0 );
32+
* double y = stdlib_base_dists_arcsine_entropy( 4.0, 12.0 );
3333
* // returns ~1.838
3434
*/
3535
double stdlib_base_dists_arcsine_entropy( const double a, const double b ) {

lib/node_modules/@stdlib/stats/base/dists/arcsine/kurtosis/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return excess kurtosis
2828
*
2929
* @example
30-
* double y = stdlib_base_arcsine_kurtosis( 0.0, 1.0 );
30+
* double y = stdlib_base_dists_arcsine_kurtosis( 0.0, 1.0 );
3131
* // returns 1.5
3232
*/
3333
double stdlib_base_dists_arcsine_kurtosis( const double a, const double b ) {

lib/node_modules/@stdlib/stats/base/dists/arcsine/variance/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return variance
2828
*
2929
* @example
30-
* double y = stdlib_base_arcsine_variance( 0.0, 1.0 );
30+
* double y = stdlib_base_dists_arcsine_variance( 0.0, 1.0 );
3131
* // returns ~0.125
3232
*/
3333
double stdlib_base_dists_arcsine_variance( const double a, const double b ) {

lib/node_modules/@stdlib/stats/base/dists/beta/stdev/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return standard deviation
2828
*
2929
* @example
30-
* double y = stdlib_base_beta_stdev( 1.0, 1.0 );
30+
* double y = stdlib_base_dists_beta_stdev( 1.0, 1.0 );
3131
* // returns ~0.289
3232
*/
3333
double stdlib_base_dists_beta_stdev( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/beta/variance/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* @return variance
2727
*
2828
* @example
29-
* double y = stdlib_base_beta_variance( 1.0, 1.0 );
29+
* double y = stdlib_base_dists_beta_variance( 1.0, 1.0 );
3030
* // returns ~0.083
3131
*/
3232
double stdlib_base_dists_beta_variance( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/betaprime/kurtosis/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return excess kurtosis
2828
*
2929
* @example
30-
* double y = stdlib_base_betaprime_kurtosis( 2.0, 6.0 );
30+
* double y = stdlib_base_dists_betaprime_kurtosis( 2.0, 6.0 );
3131
* // returns ~26.143
3232
*/
3333
double stdlib_base_dists_betaprime_kurtosis( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/betaprime/skewness/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* @return standard deviation
2929
*
3030
* @example
31-
* double y = stdlib_base_betaprime_skewness( 2.0, 4.0 );
31+
* double y = stdlib_base_dists_betaprime_skewness( 2.0, 4.0 );
3232
* // returns ~6.261
3333
*/
3434
double stdlib_base_dists_betaprime_skewness( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* @return standard deviation
2929
*
3030
* @example
31-
* double y = stdlib_base_betaprime_stdev( 1.0, 3.0 );
31+
* double y = stdlib_base_dists_betaprime_stdev( 1.0, 3.0 );
3232
* // returns ~0.866
3333
*/
3434
double stdlib_base_dists_betaprime_stdev( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/betaprime/variance/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return variance
2828
*
2929
* @example
30-
* double y = stdlib_base_betaprime_variance( 1.0, 3.0 );
30+
* double y = stdlib_base_dists_betaprime_variance( 1.0, 3.0 );
3131
* // returns ~0.75
3232
*/
3333
double stdlib_base_dists_betaprime_variance( const double alpha, const double beta ) {

0 commit comments

Comments
 (0)