Skip to content

docs: update related packages sections #12237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
May 24, 2026
Merged

docs: update related packages sections #12237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dac1d8a
docs: update related packages sections
stdlib-bot May 24, 2026
86c2887
docs: remove related section
kgryte May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/array/float64/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1432,6 +1432,7 @@ console.log( arr );
## See Also

- <span class="package-name">[`@stdlib/array/buffer`][@stdlib/array/buffer]</span><span class="delimiter">: </span><span class="description">ArrayBuffer.</span>
- <span class="package-name">[`@stdlib/array/float16`][@stdlib/array/float16]</span><span class="delimiter">: </span><span class="description">float16Array.</span>
- <span class="package-name">[`@stdlib/array/float32`][@stdlib/array/float32]</span><span class="delimiter">: </span><span class="description">Float32Array.</span>
- <span class="package-name">[`@stdlib/array/int16`][@stdlib/array/int16]</span><span class="delimiter">: </span><span class="description">Int16Array.</span>
- <span class="package-name">[`@stdlib/array/int32`][@stdlib/array/int32]</span><span class="delimiter">: </span><span class="description">Int32Array.</span>
Expand All @@ -1455,6 +1456,8 @@ console.log( arr );

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

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

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

[@stdlib/array/int16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/int16
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/random/array/binomial/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,7 @@ logEach( '%f', x4 );

## See Also

- <span class="package-name">[`@stdlib/random/binomial`][@stdlib/random/binomial]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a binomial distribution.</span>
- <span class="package-name">[`@stdlib/random/array/negative-binomial`][@stdlib/random/array/negative-binomial]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a negative binomial distribution.</span>
- <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>

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

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

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

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

<!-- </related-links> -->
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/random/array/rayleigh/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ logEach( '%f', x4 );
## See Also

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

</section>
Expand All @@ -377,6 +378,8 @@ logEach( '%f', x4 );

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

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

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

<!-- </related-links> -->
Expand Down
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/random/geometric/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/base/geometric`][@stdlib/random/base/geometric]</span><span class="delimiter">: </span><span class="description">geometric distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/array/geometric`][@stdlib/random/array/geometric]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a geometric distribution.</span>
- <span class="package-name">[`@stdlib/random/strided/geometric`][@stdlib/random/strided/geometric]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a geometric distribution.</span>

</section>

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

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

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

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

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

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

</section>

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

## See Also

- <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>
- <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>
- <span class="package-name">[`@stdlib/random/array/beta`][@stdlib/random/array/beta]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a beta distribution.</span>

Expand All @@ -230,6 +231,8 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

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

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

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

<!-- </related-links> -->
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/random/strided/betaprime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

## See Also

- <span class="package-name">[`@stdlib/random/betaprime`][@stdlib/random/betaprime]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a betaprime distribution.</span>
- <span class="package-name">[`@stdlib/random/base/betaprime`][@stdlib/random/base/betaprime]</span><span class="delimiter">: </span><span class="description">beta prime distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/array/betaprime`][@stdlib/random/array/betaprime]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a beta prime distribution.</span>

Expand All @@ -230,6 +231,8 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

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

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

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

<!-- </related-links> -->
Expand Down
14 changes: 0 additions & 14 deletions lib/node_modules/@stdlib/stats/incr/nanvariance/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,6 @@ console.log( accumulator() );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/stats/incr/variance`][@stdlib/stats/incr/variance]</span><span class="delimiter">: </span><span class="description">compute an unbiased sample variance incrementally.</span>
- <span class="package-name">[`@stdlib/stats/incr/mean`][@stdlib/stats/incr/mean]</span><span class="delimiter">: </span><span class="description">compute an arithmetic mean incrementally.</span>
- <span class="package-name">[`@stdlib/stats/incr/nansum`][@stdlib/stats/incr/nansum]</span><span class="delimiter">: </span><span class="description">compute a sum incrementally, ignoring NaN values.</span>

</section>

<!-- /.related -->
Expand All @@ -154,12 +146,6 @@ console.log( accumulator() );

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

[@stdlib/stats/incr/variance]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/variance

[@stdlib/stats/incr/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mean

[@stdlib/stats/incr/nansum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum

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

</section>
Expand Down