Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 10, 2024
1 parent d675ecd commit ed2d5fa
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 0 deletions.
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/chisquare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>

</section>

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

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

<!-- <related-links> -->

[@stdlib/random/array/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chisquare

[@stdlib/random/iter/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/chisquare

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/logistic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>

</section>

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

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

<!-- <related-links> -->

[@stdlib/random/array/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/logistic

[@stdlib/random/iter/logistic]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/logistic

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

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/strided/chisquare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

<section class="related">

* * *

## See Also

- <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>
- <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>

</section>

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

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

<!-- <related-links> -->

[@stdlib/random/array/chisquare]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/chisquare

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/random/strided/poisson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

<section class="related">

* * *

## See Also

- <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>
- <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>

</section>

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

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

<!-- <related-links> -->

[@stdlib/random/array/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/poisson

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/first-code-point/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ str = firstCodePoint( 'अनुच्छेद', 1 );

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>

</section>

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

<section class="links">

<!-- <related-links> -->

[@stdlib/string/base/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first

[@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-grapheme-cluster

[@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first

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

</section>

<!-- /.links -->

0 comments on commit ed2d5fa

Please sign in to comment.