Skip to content

Commit f505ed5

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 ---
1 parent b9a2014 commit f505ed5

File tree

13 files changed

+15
-14
lines changed
  • lib/node_modules/@stdlib/stats/base/dists

13 files changed

+15
-14
lines changed

lib/node_modules/@stdlib/stats/base/dists/arcsine/entropy/include/stdlib/stats/base/dists/arcsine/entropy.h

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

38-
#endif // !STDLIB_STATS_BASE_DISTS_ENTROPY_H
38+
#endif // !STDLIB_STATS_BASE_DISTS_ARCSINE_ENTROPY_H

lib/node_modules/@stdlib/stats/base/dists/beta/pdf/include/stdlib/stats/base/dists/beta/pdf.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#define STDLIB_STATS_BASE_DISTS_BETA_PDF_H
2121

2222
/*
23-
* If C++, prevent name mangling so that the compiler emits a ternary file having undecorated names, thus mirroring the behavior of a C compiler.
23+
* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
2424
*/
2525
#ifdef __cplusplus
2626
extern "C" {

lib/node_modules/@stdlib/stats/base/dists/betaprime/kurtosis/include/stdlib/stats/base/dists/betaprime/kurtosis.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Returns the excess kurtosis of an beta prime distribution.
30+
* Returns the excess kurtosis of a beta prime distribution.
3131
*/
3232
double stdlib_base_dists_betaprime_kurtosis( const double alpha, const double beta );
3333

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19+
#include "stdlib/stats/base/dists/degenerate/mode.h"
1920
#include "stdlib/math/base/assert/is_nan.h"
2021

2122
/**

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* @return expected value
2727
*
2828
* @example
29-
* double y = stdlib_base_invgamma_mean( 4.0, 12.0 );
29+
* double y = stdlib_base_dists_invgamma_mean( 4.0, 12.0 );
3030
* // returns 4.0
3131
*/
3232
double stdlib_base_dists_invgamma_mean( const double alpha, const double beta ) {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* @return skewness
2929
*
3030
* @example
31-
* double y = stdlib_base_invgamma_skewness( 4.0, 12.0 );
31+
* double y = stdlib_base_dists_invgamma_skewness( 4.0, 12.0 );
3232
* // returns ~5.657
3333
*/
3434
double stdlib_base_dists_invgamma_skewness( const double alpha, const double beta ) {

lib/node_modules/@stdlib/stats/base/dists/invgamma/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_invgamma_stdev( 3.0, 5.0 );
30+
* double y = stdlib_base_dists_invgamma_stdev( 3.0, 5.0 );
3131
* // returns ~2.5
3232
*/
3333
double stdlib_base_dists_invgamma_stdev( const double alpha, const double beta ) {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
* @return expected value
2929
*
3030
* @example
31-
* double y = stdlib_base_levy_mean( 0.0, 1.0 );
31+
* double y = stdlib_base_dists_levy_mean( 0.0, 1.0 );
3232
* // returns Infinity
3333
*/
3434
double stdlib_base_dists_levy_mean( const double mu, const double c ) {
3535
if (
36-
isnan( mu ) ||
37-
isnan( c ) ||
36+
stdlib_base_is_nan( mu ) ||
37+
stdlib_base_is_nan( c ) ||
3838
c <= 0.0
3939
) {
4040
return 0.0/0.0; // NaN

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @return mode
2828
*
2929
* @example
30-
* double y = stdlib_base_levy_mode( 0.0, 1.0 );
30+
* double y = stdlib_base_dists_levy_mode( 0.0, 1.0 );
3131
* // returns ~0.333
3232
*/
3333
double stdlib_base_dists_levy_mode( const double mu, const double c ) {

0 commit comments

Comments
 (0)