Skip to content

docs: fix README structure of stats/base/dists/chi/cdf #11740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Apr 23, 2026
+36 −28
Merged

docs: fix README structure of stats/base/dists/chi/cdf #11740

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55dcad1
style: align `stats/base/dists/chi/cdf` README with namespace convent…
claude Apr 23, 2026
d00667e
Merge remote-tracking branch 'upstream/develop' into philipp/drift-st…
stdlib-bot Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 36 additions & 28 deletions lib/node_modules/@stdlib/stats/base/dists/chi/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,42 @@ y = mycdf( 1.5 );
// returns ~0.478
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var cdf = require( '@stdlib/stats/base/dists/chi/cdf' );

var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );

logEachMap( 'x: %0.4f, k: %d, F(x;k): %0.4f', x, k, cdf );
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

### C APIs
<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand All @@ -137,7 +170,7 @@ y = mycdf( 1.5 );

<section class="usage">

#### Usage
### Usage

```c
#include "stdlib/stats/base/dists/chi/cdf.h"
Expand Down Expand Up @@ -213,32 +246,7 @@ int main( void ) {

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var cdf = require( '@stdlib/stats/base/dists/chi/cdf' );

var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );

logEachMap( 'x: %0.4f, k: %d, F(x;k): %0.4f', x, k, cdf );
```

</section>

<!-- /.examples -->
<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

Expand Down