Skip to content

Commit 0b15ebe

Browse files
authored
docs: update related packages sections
PR-URL: #1310 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent d675ecd commit 0b15ebe

File tree

5 files changed

+80
-0
lines changed

5 files changed

+80
-0
lines changed

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

+18
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,14 @@ for ( i = 0; i < 100; i++ ) {
398398

399399
<section class="related">
400400

401+
* * *
402+
403+
## See Also
404+
405+
- <span class="package-name">[`@stdlib/random/array/chisquare`][@stdlib/random/array/chisquare]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a chi-square distribution.</span>
406+
- <span class="package-name">[`@stdlib/random/iter/chisquare`][@stdlib/random/iter/chisquare]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a chi-square distribution.</span>
407+
- <span class="package-name">[`@stdlib/random/streams/chisquare`][@stdlib/random/streams/chisquare]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a chi-square distribution.</span>
408+
401409
</section>
402410

403411
<!-- /.related -->
@@ -410,6 +418,16 @@ for ( i = 0; i < 100; i++ ) {
410418

411419
[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
412420

421+
<!-- <related-links> -->
422+
423+
[@stdlib/random/array/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chisquare
424+
425+
[@stdlib/random/iter/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/chisquare
426+
427+
[@stdlib/random/streams/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/chisquare
428+
429+
<!-- </related-links> -->
430+
413431
</section>
414432

415433
<!-- /.links -->

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

+18
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {
401401

402402
<section class="related">
403403

404+
* * *
405+
406+
## See Also
407+
408+
- <span class="package-name">[`@stdlib/random/array/logistic`][@stdlib/random/array/logistic]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a logistic distribution.</span>
409+
- <span class="package-name">[`@stdlib/random/iter/logistic`][@stdlib/random/iter/logistic]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a logistic distribution.</span>
410+
- <span class="package-name">[`@stdlib/random/streams/logistic`][@stdlib/random/streams/logistic]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a logistic distribution.</span>
411+
404412
</section>
405413

406414
<!-- /.related -->
@@ -413,6 +421,16 @@ for ( i = 0; i < 100; i++ ) {
413421

414422
[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
415423

424+
<!-- <related-links> -->
425+
426+
[@stdlib/random/array/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/logistic
427+
428+
[@stdlib/random/iter/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/logistic
429+
430+
[@stdlib/random/streams/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/logistic
431+
432+
<!-- </related-links> -->
433+
416434
</section>
417435

418436
<!-- /.links -->

lib/node_modules/@stdlib/random/strided/chisquare/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
356356

357357
<section class="related">
358358

359+
* * *
360+
361+
## See Also
362+
363+
- <span class="package-name">[`@stdlib/random/base/chisquare`][@stdlib/random/base/chisquare]</span><span class="delimiter">: </span><span class="description">Chi-square distributed pseudorandom numbers.</span>
364+
- <span class="package-name">[`@stdlib/random/array/chisquare`][@stdlib/random/array/chisquare]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a chi-square distribution.</span>
365+
359366
</section>
360367

361368
<!-- /.related -->
@@ -370,6 +377,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
370377

371378
[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
372379

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

375388
<!-- /.links -->

lib/node_modules/@stdlib/random/strided/poisson/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
356356

357357
<section class="related">
358358

359+
* * *
360+
361+
## See Also
362+
363+
- <span class="package-name">[`@stdlib/random/base/poisson`][@stdlib/random/base/poisson]</span><span class="delimiter">: </span><span class="description">Poisson distributed random numbers.</span>
364+
- <span class="package-name">[`@stdlib/random/array/poisson`][@stdlib/random/array/poisson]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Poisson distribution.</span>
365+
359366
</section>
360367

361368
<!-- /.related -->
@@ -370,6 +377,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
370377

371378
[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
372379

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

375388
<!-- /.links -->

lib/node_modules/@stdlib/string/base/first-code-point/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ str = firstCodePoint( 'अनुच्छेद', 1 );
8282

8383
<section class="related">
8484

85+
* * *
86+
87+
## See Also
88+
89+
- <span class="package-name">[`@stdlib/string/base/first`][@stdlib/string/base/first]</span><span class="delimiter">: </span><span class="description">return the first UTF-16 code unit of a string.</span>
90+
- <span class="package-name">[`@stdlib/string/base/first-grapheme-cluster`][@stdlib/string/base/first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the first grapheme cluster (i.e., user-perceived character) of a string.</span>
91+
- <span class="package-name">[`@stdlib/string/first`][@stdlib/string/first]</span><span class="delimiter">: </span><span class="description">return the first character(s) of a string.</span>
92+
8593
</section>
8694

8795
<!-- /.related -->
@@ -90,6 +98,16 @@ str = firstCodePoint( 'अनुच्छेद', 1 );
9098

9199
<section class="links">
92100

101+
<!-- <related-links> -->
102+
103+
[@stdlib/string/base/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first
104+
105+
[@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-grapheme-cluster
106+
107+
[@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first
108+
109+
<!-- </related-links> -->
110+
93111
</section>
94112

95113
<!-- /.links -->

0 commit comments

Comments
 (0)