docs: update related packages sections

PR-URL: #1320 Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Feb 19, 2024 · 4315e33 · 4315e33 · stdlib-bot · Feb 19, 2024
1 parent 5b3b916
commit 4315e33
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 0 deletions.
diff --git a/lib/node_modules/@stdlib/math/base/special/ellipj/README.md b/lib/node_modules/@stdlib/math/base/special/ellipj/README.md
@@ -183,6 +183,15 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/ellipe`][@stdlib/math/base/special/ellipe]</span><span class="delimiter">: </span><span class="description">compute the complete elliptic integral of the second kind.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/ellipk`][@stdlib/math/base/special/ellipk]</span><span class="delimiter">: </span><span class="description">compute the complete elliptic integral of the first kind.</span>
+
+</section>
+
 <!-- /.related -->
 
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -199,6 +208,10 @@ for ( i = 0; i < 100; i++ ) {
 
 <!-- <related-links> -->
 
+[@stdlib/math/base/special/ellipe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipe
+
+[@stdlib/math/base/special/ellipk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipk
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/random/base/f/README.md b/lib/node_modules/@stdlib/random/base/f/README.md
@@ -409,6 +409,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/array/f`][@stdlib/random/array/f]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an F distribution.</span>
+-   <span class="package-name">[`@stdlib/random/iter/f`][@stdlib/random/iter/f]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an F distribution.</span>
+-   <span class="package-name">[`@stdlib/random/streams/f`][@stdlib/random/streams/f]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from an F distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -421,6 +429,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/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/f
+
+[@stdlib/random/iter/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/f
+
+[@stdlib/random/streams/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/f
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/base/randu/README.md b/lib/node_modules/@stdlib/random/base/randu/README.md
@@ -312,6 +312,9 @@ for ( i = 0; i < 100; i++ ) {
 
 ## See Also
 
+-   <span class="package-name">[`@stdlib/random/array/randu`][@stdlib/random/array/randu]</span><span class="delimiter">: </span><span class="description">create an array containing uniformly distributed pseudorandom numbers between 0 and 1.</span>
+-   <span class="package-name">[`@stdlib/random/iter/randu`][@stdlib/random/iter/randu]</span><span class="delimiter">: </span><span class="description">create an iterator for generating uniformly distributed pseudorandom numbers between 0 and 1.</span>
+-   <span class="package-name">[`@stdlib/random/streams/randu`][@stdlib/random/streams/randu]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating uniformly distributed pseudorandom numbers between 0 and 1.</span>
 -   <span class="package-name">[`@stdlib/random/base/discrete-uniform`][@stdlib/random/base/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distributed pseudorandom numbers.</span>
 -   <span class="package-name">[`@stdlib/random/base/randn`][@stdlib/random/base/randn]</span><span class="delimiter">: </span><span class="description">standard normal pseudorandom numbers.</span>
 
@@ -331,6 +334,12 @@ for ( i = 0; i < 100; i++ ) {
 
 <!-- <related-links> -->
 
+[@stdlib/random/array/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/randu
+
+[@stdlib/random/iter/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/randu
+
+[@stdlib/random/streams/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/randu
+
 [@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/discrete-uniform
 
 [@stdlib/random/base/randn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/randn

diff --git a/lib/node_modules/@stdlib/random/strided/rayleigh/README.md b/lib/node_modules/@stdlib/random/strided/rayleigh/README.md
@@ -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/rayleigh`][@stdlib/random/base/rayleigh]</span><span class="delimiter">: </span><span class="description">Rayleigh distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random/array/rayleigh`][@stdlib/random/array/rayleigh]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Rayleigh distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -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/rayleigh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/rayleigh
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
Package	Statements	Branches	Functions	Lines
math/base/special/ellipj	$\color{red}641/653$ $\color{green}+98.16\%$	$\color{red}30/32$ $\color{green}+93.75\%$	$\color{green}6/6$ $\color{green}+100.00\%$	$\color{red}641/653$ $\color{green}+98.16\%$
random/base/f	$\color{green}490/490$ $\color{green}+100.00\%$	$\color{green}55/55$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}490/490$ $\color{green}+100.00\%$
random/base/randu	$\color{green}381/381$ $\color{green}+100.00\%$	$\color{green}34/34$ $\color{green}+100.00\%$	$\color{green}9/9$ $\color{green}+100.00\%$	$\color{green}381/381$ $\color{green}+100.00\%$
random/strided/rayleigh	$\color{green}181/181$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}181/181$ $\color{green}+100.00\%$