Skip to content

Commit 795cdc0

Browse files
authored
docs: update related packages sections
PR-URL: #12122 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 32f6946 commit 795cdc0

6 files changed

Lines changed: 32 additions & 1 deletion

File tree

lib/node_modules/@stdlib/assert/is-numeric-array/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ bool = isNumericArray( new Buffer( 10 ) );
141141

142142
- <span class="package-name">[`@stdlib/assert/is-array`][@stdlib/assert/is-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array.</span>
143143
- <span class="package-name">[`@stdlib/assert/is-number-array`][@stdlib/assert/is-number-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object of numbers.</span>
144-
- <span class="package-name">[`@stdlib/assert/is-typed-array`][@stdlib/assert/is-typed-array]</span><span class="delimiter">: </span><span class="description">test if a value is a typed array.</span>
144+
- <span class="package-name">[`@stdlib/assert/is-typed-array`][@stdlib/assert/is-typed-array]</span><span class="delimiter">: </span><span class="description">test if a value is a built-in typed array.</span>
145145

146146
</section>
147147

lib/node_modules/@stdlib/random/array/beta/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,7 @@ logEach( '%f', x4 );
358358

359359
## See Also
360360

361+
- <span class="package-name">[`@stdlib/random/beta`][@stdlib/random/beta]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a beta distribution.</span>
361362
- <span class="package-name">[`@stdlib/random/base/beta`][@stdlib/random/base/beta]</span><span class="delimiter">: </span><span class="description">beta distributed pseudorandom numbers.</span>
362363
- <span class="package-name">[`@stdlib/random/strided/beta`][@stdlib/random/strided/beta]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a beta distribution.</span>
363364

@@ -379,6 +380,8 @@ logEach( '%f', x4 );
379380

380381
<!-- <related-links> -->
381382

383+
[@stdlib/random/beta]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/beta
384+
382385
[@stdlib/random/strided/beta]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/beta
383386

384387
<!-- </related-links> -->

lib/node_modules/@stdlib/random/array/chi/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,7 @@ logEach( '%f', x4 );
356356

357357
## See Also
358358

359+
- <span class="package-name">[`@stdlib/random/chi`][@stdlib/random/chi]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a chi distribution.</span>
359360
- <span class="package-name">[`@stdlib/random/base/chi`][@stdlib/random/base/chi]</span><span class="delimiter">: </span><span class="description">Chi distributed pseudorandom numbers.</span>
360361
- <span class="package-name">[`@stdlib/random/strided/chi`][@stdlib/random/strided/chi]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a chi distribution.</span>
361362

@@ -377,6 +378,8 @@ logEach( '%f', x4 );
377378

378379
<!-- <related-links> -->
379380

381+
[@stdlib/random/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/chi
382+
380383
[@stdlib/random/strided/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/chi
381384

382385
<!-- </related-links> -->

lib/node_modules/@stdlib/random/base/hypergeometric/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,7 @@ for ( i = 0; i < 100; i++ ) {
430430
- <span class="package-name">[`@stdlib/random/array/hypergeometric`][@stdlib/random/array/hypergeometric]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a hypergeometric distribution.</span>
431431
- <span class="package-name">[`@stdlib/random/iter/hypergeometric`][@stdlib/random/iter/hypergeometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a hypergeometric distribution.</span>
432432
- <span class="package-name">[`@stdlib/random/streams/hypergeometric`][@stdlib/random/streams/hypergeometric]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a hypergeometric distribution.</span>
433+
- <span class="package-name">[`@stdlib/random/hypergeometric`][@stdlib/random/hypergeometric]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a hypergeometric distribution.</span>
433434

434435
</section>
435436

@@ -453,6 +454,8 @@ for ( i = 0; i < 100; i++ ) {
453454

454455
[@stdlib/random/streams/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/hypergeometric
455456

457+
[@stdlib/random/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/hypergeometric
458+
456459
<!-- </related-links> -->
457460

458461
</section>

lib/node_modules/@stdlib/random/base/levy/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,7 @@ for ( i = 0; i < 100; i++ ) {
408408
- <span class="package-name">[`@stdlib/random/array/levy`][@stdlib/random/array/levy]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Lévy distribution.</span>
409409
- <span class="package-name">[`@stdlib/random/iter/levy`][@stdlib/random/iter/levy]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Lévy distribution.</span>
410410
- <span class="package-name">[`@stdlib/random/streams/levy`][@stdlib/random/streams/levy]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Lévy distribution.</span>
411+
- <span class="package-name">[`@stdlib/random/levy`][@stdlib/random/levy]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Lévy distribution.</span>
411412

412413
</section>
413414

@@ -429,6 +430,8 @@ for ( i = 0; i < 100; i++ ) {
429430

430431
[@stdlib/random/streams/levy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/levy
431432

433+
[@stdlib/random/levy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/levy
434+
432435
<!-- </related-links> -->
433436

434437
</section>

lib/node_modules/@stdlib/random/uniform/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,15 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
363363

364364
<section class="related">
365365

366+
* * *
367+
368+
## See Also
369+
370+
- <span class="package-name">[`@stdlib/random/discrete-uniform`][@stdlib/random/discrete-uniform]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a discrete uniform distribution.</span>
371+
- <span class="package-name">[`@stdlib/random/base/uniform`][@stdlib/random/base/uniform]</span><span class="delimiter">: </span><span class="description">uniformly distributed pseudorandom numbers.</span>
372+
- <span class="package-name">[`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
373+
- <span class="package-name">[`@stdlib/random/strided/uniform`][@stdlib/random/strided/uniform]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a continuous uniform distribution.</span>
374+
366375
</section>
367376

368377
<!-- /.related -->
@@ -383,6 +392,16 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
383392

384393
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
385394

395+
<!-- <related-links> -->
396+
397+
[@stdlib/random/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/discrete-uniform
398+
399+
[@stdlib/random/array/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform
400+
401+
[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/uniform
402+
403+
<!-- </related-links> -->
404+
386405
</section>
387406

388407
<!-- /.links -->

0 commit comments

Comments
 (0)