Skip to content

Commit ebc4ef4

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#1273 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 442fbfc commit ebc4ef4

5 files changed

Lines changed: 85 additions & 2 deletions

File tree

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,14 @@ for ( i = 0; i < 100; i++ ) {
421421

422422
<section class="related">
423423

424+
* * *
425+
426+
## See Also
427+
428+
- <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>
429+
- <span class="package-name">[`@stdlib/random/iter/binomial`][@stdlib/random/iter/binomial]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a binomial distribution.</span>
430+
- <span class="package-name">[`@stdlib/random/streams/binomial`][@stdlib/random/streams/binomial]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a binomial distribution.</span>
431+
424432
</section>
425433

426434
<!-- /.related -->
@@ -435,6 +443,16 @@ for ( i = 0; i < 100; i++ ) {
435443

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

446+
<!-- <related-links> -->
447+
448+
[@stdlib/random/array/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/binomial
449+
450+
[@stdlib/random/iter/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/binomial
451+
452+
[@stdlib/random/streams/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/binomial
453+
454+
<!-- </related-links> -->
455+
438456
</section>
439457

440458
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/invgamma/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,14 @@ for ( i = 0; i < 100; i++ ) {
408408

409409
<section class="related">
410410

411+
* * *
412+
413+
## See Also
414+
415+
- <span class="package-name">[`@stdlib/random/array/invgamma`][@stdlib/random/array/invgamma]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an inverse gamma distribution.</span>
416+
- <span class="package-name">[`@stdlib/random/iter/invgamma`][@stdlib/random/iter/invgamma]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.</span>
417+
- <span class="package-name">[`@stdlib/random/streams/invgamma`][@stdlib/random/streams/invgamma]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from an inverse gamma distribution.</span>
418+
411419
</section>
412420

413421
<!-- /.related -->
@@ -420,6 +428,16 @@ for ( i = 0; i < 100; i++ ) {
420428

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

431+
<!-- <related-links> -->
432+
433+
[@stdlib/random/array/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/invgamma
434+
435+
[@stdlib/random/iter/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/invgamma
436+
437+
[@stdlib/random/streams/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/invgamma
438+
439+
<!-- </related-links> -->
440+
423441
</section>
424442

425443
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/lognormal/README.md‎

Lines changed: 18 additions & 0 deletions
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/lognormal`][@stdlib/random/array/lognormal]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a lognormal distribution.</span>
409+
- <span class="package-name">[`@stdlib/random/iter/lognormal`][@stdlib/random/iter/lognormal]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a lognormal distribution.</span>
410+
- <span class="package-name">[`@stdlib/random/streams/lognormal`][@stdlib/random/streams/lognormal]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a lognormal 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/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/lognormal
427+
428+
[@stdlib/random/iter/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/lognormal
429+
430+
[@stdlib/random/streams/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/lognormal
431+
432+
<!-- </related-links> -->
433+
416434
</section>
417435

418436
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/normal/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,14 @@ for ( i = 0; i < 100; i++ ) {
402402

403403
<section class="related">
404404

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

407415
<!-- /.related -->
@@ -414,6 +422,16 @@ for ( i = 0; i < 100; i++ ) {
414422

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

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

419437
<!-- /.links -->

‎lib/node_modules/@stdlib/string/first/README.md‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The function supports the following options:
4949
- `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
5050
- `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
5151
- `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
52-
52+
5353
Default: `'grapheme'`.
5454

5555
By default, the function returns the first character. To return the first `n` characters, provide a second argument specifying the number of characters to return.
@@ -78,7 +78,6 @@ out = first( 'foo bar', 10 );
7878

7979
<!-- /.notes -->
8080

81-
8281
<section class="examples">
8382

8483
## Examples
@@ -199,6 +198,12 @@ b
199198

200199
<section class="related">
201200

201+
* * *
202+
203+
## See Also
204+
205+
- <span class="package-name">[`@stdlib/string/remove-first`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>
206+
202207
</section>
203208

204209
<!-- /.related -->
@@ -211,6 +216,12 @@ b
211216

212217
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
213218

219+
<!-- <related-links> -->
220+
221+
[@stdlib/string/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/remove-first
222+
223+
<!-- </related-links> -->
224+
214225
</section>
215226

216227
<!-- /.links -->

0 commit comments

Comments
 (0)