Skip to content

Commit

Permalink
docs: update descriptions
Browse files Browse the repository at this point in the history
---
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: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - 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: passed
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: passed
  - 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: passed
---
  • Loading branch information
kgryte committed Jan 20, 2025
1 parent d60fca2 commit 895313e
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ tape( 'if provided a negative `s`, the function returns `NaN`', function test( t
t.end();
});

tape( 'if provided `sigma` equals `0`, the function evaluates a degenerate distribution centered at `mu`', function test( t ) {
tape( 'if provided `s` equals `0`, the function evaluates a degenerate distribution centered at `mu`', function test( t ) {
var y;

y = cdf( 2.0, 2.0, 0.0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ tape( 'if provided a negative `s`, the created function always returns `NaN`', f
t.end();
});

tape( 'if `sigma` equals `0`, the created function evaluates a degenerate distribution centered at `mu`', function test( t ) {
tape( 'if `s` equals `0`, the created function evaluates a degenerate distribution centered at `mu`', function test( t ) {
var cdf;
var y;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ tape( 'if provided a negative `s`, the function returns `NaN`', opts, function t
t.end();
});

tape( 'if provided `sigma` equals `0`, the function evaluates a degenerate distribution centered at `mu`', opts, function test( t ) {
tape( 'if provided `s` equals `0`, the function evaluates a degenerate distribution centered at `mu`', opts, function test( t ) {
var y;

y = cdf( 2.0, 2.0, 0.0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ extern "C" {
#endif

/**
* Evaluates the natural logarithm of the cumulative distribution function (LOGCDF) for a raised cosine distribution with parameters `mu` (location parameter) and `s` (scale parameter).
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a raised cosine distribution with parameters `mu` (location parameter) and `s` (scale parameter).
*/
double stdlib_base_dists_cosine_logcdf( const double x, const double mu, const double s );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ tape( 'if provided a negative `s`, the created function always returns `NaN`', f
t.end();
});

tape( 'if `sigma` equals `0`, the created function evaluates a degenerate distribution centered at `mu`', function test( t ) {
tape( 'if `s` equals `0`, the created function evaluates a degenerate distribution centered at `mu`', function test( t ) {
var logcdf;
var y;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ tape( 'if provided a negative `s`, the function returns `NaN`', function test( t
t.end();
});

tape( 'if provided `sigma` equals `0`, the function evaluates a degenerate distribution centered at `mu`', function test( t ) {
tape( 'if provided `s` equals `0`, the function evaluates a degenerate distribution centered at `mu`', function test( t ) {
var y;

y = logcdf( 2.0, 2.0, 0.0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ tape( 'if provided a negative `s`, the function returns `NaN`', opts, function t
t.end();
});

tape( 'if provided `sigma` equals `0`, the function evaluates a degenerate distribution centered at `mu`', opts, function test( t ) {
tape( 'if provided `s` equals `0`, the function evaluates a degenerate distribution centered at `mu`', opts, function test( t ) {
var y;

y = logcdf( 2.0, 2.0, 0.0 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ tape( 'if provided `NaN` for any parameter, the created function returns `NaN`',
t.end();
});

tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `-infinity` when provided `x` greater than `mu + sigma`', function test( t ) {
tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `-infinity` when provided `x` greater than `mu + s`', function test( t ) {
var logpdf;
var y;

Expand All @@ -95,7 +95,7 @@ tape( 'if provided a finite `mu` and `s`, the function returns a function which
t.end();
});

tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `-infinity` when provided `x` smaller than `mu - sigma`', function test( t ) {
tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `-infinity` when provided `x` smaller than `mu - s`', function test( t ) {
var logpdf;
var y;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ tape( 'if provided `NaN` for any parameter, the function returns `NaN`', functio
t.end();
});

tape( 'if provided `x` greater than `mu + sigma`, the function returns `-infinity`', function test( t ) {
tape( 'if provided `x` greater than `mu + s`, the function returns `-infinity`', function test( t ) {
var y = logpdf( PINF, 0.0, 1.0 );
t.equal( y, NINF, 'returns -infinity' );

Expand All @@ -67,7 +67,7 @@ tape( 'if provided `x` greater than `mu + sigma`, the function returns `-infinit
t.end();
});

tape( 'if provided `x` smaller than `mu - sigma`, the function returns `-infinity`', function test( t ) {
tape( 'if provided `x` smaller than `mu - s`, the function returns `-infinity`', function test( t ) {
var y = logpdf( NINF, 0.0, 1.0 );
t.equal( y, NINF, 'returns -infinity' );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, f
t.end();
});

tape( 'if provided `x` greater than `mu + sigma`, the function returns `-infinity`', opts, function test( t ) {
tape( 'if provided `x` greater than `mu + s`, the function returns `-infinity`', opts, function test( t ) {
var y = logpdf( PINF, 0.0, 1.0 );
t.equal( y, NINF, 'returns -infinity' );

Expand All @@ -76,7 +76,7 @@ tape( 'if provided `x` greater than `mu + sigma`, the function returns `-infinit
t.end();
});

tape( 'if provided `x` smaller than `mu - sigma`, the function returns `-infinity`', opts, function test( t ) {
tape( 'if provided `x` smaller than `mu - s`, the function returns `-infinity`', opts, function test( t ) {
var y = logpdf( NINF, 0.0, 1.0 );
t.equal( y, NINF, 'returns -infinity' );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ tape( 'if provided `NaN` for any parameter, the created function returns `NaN`',
t.end();
});

tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `0` when provided `x` greater than `mu + sigma`', function test( t ) {
tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `0` when provided `x` greater than `mu + s`', function test( t ) {
var pdf;
var y;

Expand All @@ -95,7 +95,7 @@ tape( 'if provided a finite `mu` and `s`, the function returns a function which
t.end();
});

tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `0` when provided `x` smaller than `mu - sigma`', function test( t ) {
tape( 'if provided a finite `mu` and `s`, the function returns a function which returns `0` when provided `x` smaller than `mu - s`', function test( t ) {
var pdf;
var y;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, f
t.end();
});

tape( 'if provided `x` greater than `mu + sigma`,, the function returns `0`', opts, function test( t ) {
tape( 'if provided `x` greater than `mu + s`, the function returns `0`', opts, function test( t ) {
var y = pdf( PINF, 0.0, 1.0 );
t.equal( y, 0.0, 'returns 0' );

Expand All @@ -76,7 +76,7 @@ tape( 'if provided `x` greater than `mu + sigma`,, the function returns `0`', op
t.end();
});

tape( 'if provided `x` smaller than `mu - sigma`, the function returns `0`', opts, function test( t ) {
tape( 'if provided `x` smaller than `mu - s`, the function returns `0`', opts, function test( t ) {
var y = pdf( NINF, 0.0, 1.0 );
t.equal( y, 0.0, 'returns 0' );

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ tape( 'if provided `NaN` for any parameter, the function returns `NaN`', functio
t.end();
});

tape( 'if provided `x` greater than `mu + sigma`,, the function returns `0`', function test( t ) {
tape( 'if provided `x` greater than `mu + s`, the function returns `0`', function test( t ) {
var y = pdf( PINF, 0.0, 1.0 );
t.equal( y, 0.0, 'returns 0' );

Expand All @@ -67,7 +67,7 @@ tape( 'if provided `x` greater than `mu + sigma`,, the function returns `0`', fu
t.end();
});

tape( 'if provided `x` smaller than `mu - sigma`, the function returns `0`', function test( t ) {
tape( 'if provided `x` smaller than `mu - s`, the function returns `0`', function test( t ) {
var y = pdf( NINF, 0.0, 1.0 );
t.equal( y, 0.0, 'returns 0' );

Expand Down

0 comments on commit 895313e

Please sign in to comment.