Skip to content

Commit 750ace1

Browse files
committed
style: align stats/base/dists/chisquare/cdf with namespace conventions
Moved the JS `## Examples` section above `## C APIs` to match the namespace-wide README section ordering (contiguous `## Usage` -> `## Examples` appears in 12/14 chisquare packages, 86%). No content changes; purely reordering.
1 parent 9188369 commit 750ace1

1 file changed

Lines changed: 25 additions & 27 deletions

File tree

  • lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf

lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/README.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,31 @@ y = mycdf( 1.5 );
125125

126126
<!-- /.usage -->
127127

128+
<section class="examples">
129+
130+
## Examples
131+
132+
<!-- eslint no-undef: "error" -->
133+
134+
```javascript
135+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
136+
var uniform = require( '@stdlib/random/array/uniform' );
137+
var logEachMap = require( '@stdlib/console/log-each-map' );
138+
var cdf = require( '@stdlib/stats/base/dists/chisquare/cdf' );
139+
140+
var opts = {
141+
'dtype': 'float64'
142+
};
143+
var x = uniform( 20, 0.0, 10.0, opts );
144+
var k = discreteUniform( 20, 0, 10, opts );
145+
146+
logEachMap( 'x: %0.4f, k: %d, F(x;k): %0.4f', x, k, cdf );
147+
```
148+
149+
</section>
150+
151+
<!-- /.examples -->
152+
128153
* * *
129154

130155
<section class="c">
@@ -207,33 +232,6 @@ int main( void ) {
207232

208233
<!-- /.c -->
209234

210-
* * *
211-
212-
<section class="examples">
213-
214-
## Examples
215-
216-
<!-- eslint no-undef: "error" -->
217-
218-
```javascript
219-
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
220-
var uniform = require( '@stdlib/random/array/uniform' );
221-
var logEachMap = require( '@stdlib/console/log-each-map' );
222-
var cdf = require( '@stdlib/stats/base/dists/chisquare/cdf' );
223-
224-
var opts = {
225-
'dtype': 'float64'
226-
};
227-
var x = uniform( 20, 0.0, 10.0, opts );
228-
var k = discreteUniform( 20, 0, 10, opts );
229-
230-
logEachMap( 'x: %0.4f, k: %d, F(x;k): %0.4f', x, k, cdf );
231-
```
232-
233-
</section>
234-
235-
<!-- /.examples -->
236-
237235
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
238236

239237
<section class="related">

0 commit comments

Comments
 (0)