Skip to content

Commit 0a24f0b

Browse files
authored
docs: update related packages sections
PR-URL: #12338 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent d2700aa commit 0a24f0b

7 files changed

Lines changed: 60 additions & 2 deletions

File tree

lib/node_modules/@stdlib/random/array/exponential/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/exponential`][@stdlib/random/exponential]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an exponential distribution.</span>
359360
- <span class="package-name">[`@stdlib/random/base/exponential`][@stdlib/random/base/exponential]</span><span class="delimiter">: </span><span class="description">exponentially distributed pseudorandom numbers.</span>
360361
- <span class="package-name">[`@stdlib/random/strided/exponential`][@stdlib/random/strided/exponential]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from an exponential distribution.</span>
361362

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

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

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

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

lib/node_modules/@stdlib/random/array/pareto-type1/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ logEach( '%f', x4 );
359359
## See Also
360360

361361
- <span class="package-name">[`@stdlib/random/base/pareto-type1`][@stdlib/random/base/pareto-type1]</span><span class="delimiter">: </span><span class="description">Pareto (Type I) distributed pseudorandom numbers.</span>
362+
- <span class="package-name">[`@stdlib/random/pareto-type1`][@stdlib/random/pareto-type1]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Pareto (Type I) distribution.</span>
362363

363364
</section>
364365

@@ -376,6 +377,12 @@ logEach( '%f', x4 );
376377

377378
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
378379

380+
<!-- <related-links> -->
381+
382+
[@stdlib/random/pareto-type1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/pareto-type1
383+
384+
<!-- </related-links> -->
385+
379386
</section>
380387

381388
<!-- /.links -->

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,7 @@ for ( i = 0; i < 100; i++ ) {
405405
- <span class="package-name">[`@stdlib/random/array/chi`][@stdlib/random/array/chi]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a chi distribution.</span>
406406
- <span class="package-name">[`@stdlib/random/iter/chi`][@stdlib/random/iter/chi]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a chi distribution.</span>
407407
- <span class="package-name">[`@stdlib/random/streams/chi`][@stdlib/random/streams/chi]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a chi distribution.</span>
408+
- <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>
408409

409410
</section>
410411

@@ -426,6 +427,8 @@ for ( i = 0; i < 100; i++ ) {
426427

427428
[@stdlib/random/streams/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/chi
428429

430+
[@stdlib/random/chi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/chi
431+
429432
<!-- </related-links> -->
430433

431434
</section>

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
358358

359359
<section class="related">
360360

361+
* * *
362+
363+
## See Also
364+
365+
- <span class="package-name">[`@stdlib/random/base/bernoulli`][@stdlib/random/base/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distributed pseudorandom numbers.</span>
366+
- <span class="package-name">[`@stdlib/random/array/bernoulli`][@stdlib/random/array/bernoulli]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Bernoulli distribution.</span>
367+
- <span class="package-name">[`@stdlib/random/strided/bernoulli`][@stdlib/random/strided/bernoulli]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Bernoulli distribution.</span>
368+
361369
</section>
362370

363371
<!-- /.related -->
@@ -378,6 +386,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
378386

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

389+
<!-- <related-links> -->
390+
391+
[@stdlib/random/array/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/bernoulli
392+
393+
[@stdlib/random/strided/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/bernoulli
394+
395+
<!-- </related-links> -->
396+
381397
</section>
382398

383399
<!-- /.links -->

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,13 @@ 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/base/binomial`][@stdlib/random/base/binomial]</span><span class="delimiter">: </span><span class="description">binomial distributed pseudorandom numbers.</span>
371+
- <span class="package-name">[`@stdlib/random/array/binomial`][@stdlib/random/array/binomial]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a binomial distribution.</span>
372+
366373
</section>
367374

368375
<!-- /.related -->
@@ -383,6 +390,12 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
383390

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

393+
<!-- <related-links> -->
394+
395+
[@stdlib/random/array/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/binomial
396+
397+
<!-- </related-links> -->
398+
386399
</section>
387400

388401
<!-- /.links -->

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
358358

359359
<section class="related">
360360

361+
* * *
362+
363+
## See Also
364+
365+
- <span class="package-name">[`@stdlib/random/base/exponential`][@stdlib/random/base/exponential]</span><span class="delimiter">: </span><span class="description">exponentially distributed pseudorandom numbers.</span>
366+
- <span class="package-name">[`@stdlib/random/array/exponential`][@stdlib/random/array/exponential]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an exponential distribution.</span>
367+
- <span class="package-name">[`@stdlib/random/strided/exponential`][@stdlib/random/strided/exponential]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from an exponential distribution.</span>
368+
361369
</section>
362370

363371
<!-- /.related -->
@@ -378,6 +386,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
378386

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

389+
<!-- <related-links> -->
390+
391+
[@stdlib/random/array/exponential]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/exponential
392+
393+
[@stdlib/random/strided/exponential]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/exponential
394+
395+
<!-- </related-links> -->
396+
381397
</section>
382398

383399
<!-- /.links -->

lib/node_modules/@stdlib/strided/base/unary/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6391,7 +6391,7 @@ int main( void ) {
63916391

63926392
## See Also
63936393

6394-
- <span class="package-name">[`@stdlib/strided/base/unary`][@stdlib/strided/base/unary]</span><span class="delimiter">: </span><span class="description">apply a unary callback to elements in a strided input array and assign results to elements in a strided output array.</span>
6394+
- <span class="package-name">[`@stdlib/strided/base/binary`][@stdlib/strided/base/binary]</span><span class="delimiter">: </span><span class="description">apply a binary callback to elements in strided input arrays and assign results to elements in a strided output array.</span>
63956395
- <span class="package-name">[`@stdlib/strided/base/dmap`][@stdlib/strided/base/dmap]</span><span class="delimiter">: </span><span class="description">apply a unary function to a double-precision floating-point strided input array and assign results to a double-precision floating-point strided output array.</span>
63966396
- <span class="package-name">[`@stdlib/strided/base/nullary`][@stdlib/strided/base/nullary]</span><span class="delimiter">: </span><span class="description">apply a nullary callback and assign results to elements in a strided output array.</span>
63976397
- <span class="package-name">[`@stdlib/strided/base/quaternary`][@stdlib/strided/base/quaternary]</span><span class="delimiter">: </span><span class="description">apply a quaternary callback to strided input array elements and assign results to elements in a strided output array.</span>
@@ -6411,7 +6411,7 @@ int main( void ) {
64116411

64126412
<!-- <related-links> -->
64136413

6414-
[@stdlib/strided/base/unary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/unary
6414+
[@stdlib/strided/base/binary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/binary
64156415

64166416
[@stdlib/strided/base/dmap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dmap
64176417

0 commit comments

Comments
 (0)