docs: update related packages sections

stdlib-js · Feb 9, 2024 · 7fc82bf · 7fc82bf
1 parent 6008b22
commit 7fc82bf
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 1 deletion.
diff --git a/lib/node_modules/@stdlib/array/cartesian-power/README.md b/lib/node_modules/@stdlib/array/cartesian-power/README.md
@@ -89,6 +89,13 @@ var out = cartesianPower( x, 3 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/cartesian-product`][@stdlib/array/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
+-   <span class="package-name">[`@stdlib/array/cartesian-square`][@stdlib/array/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
+
 </section>
 
 <!-- /.related -->
@@ -99,6 +106,14 @@ var out = cartesianPower( x, 3 );
 
 [cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
 
+<!-- <related-links> -->
+
+[@stdlib/array/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-product
+
+[@stdlib/array/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-square
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/array/cartesian-square/README.md b/lib/node_modules/@stdlib/array/cartesian-square/README.md
@@ -82,6 +82,13 @@ var out = cartesianSquare( x );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/cartesian-power`][@stdlib/array/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
+-   <span class="package-name">[`@stdlib/array/cartesian-product`][@stdlib/array/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
+
 </section>
 
 <!-- /.related -->
@@ -92,6 +99,14 @@ var out = cartesianSquare( x );
 
 [cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
 
+<!-- <related-links> -->
+
+[@stdlib/array/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-power
+
+[@stdlib/array/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-product
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/array/typed-complex-dtypes/README.md b/lib/node_modules/@stdlib/array/typed-complex-dtypes/README.md
@@ -117,7 +117,7 @@ bool = isdtype( 'beep' );
 
 -   <span class="package-name">[`@stdlib/array/dtypes`][@stdlib/array/dtypes]</span><span class="delimiter">: </span><span class="description">list of array data types.</span>
 -   <span class="package-name">[`@stdlib/array/typed-dtypes`][@stdlib/array/typed-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
--   <span class="package-name">[`@stdlib/array/typed-real-dtypes`][@stdlib/array/typed-real-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
+-   <span class="package-name">[`@stdlib/array/typed-real-dtypes`][@stdlib/array/typed-real-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array real-valued data types.</span>
 -   <span class="package-name">[`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
 
 </section>

diff --git a/lib/node_modules/@stdlib/random/base/geometric/README.md b/lib/node_modules/@stdlib/random/base/geometric/README.md
@@ -405,6 +405,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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/iter/geometric`][@stdlib/random/iter/geometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a geometric distribution.</span>
+-   <span class="package-name">[`@stdlib/random/streams/geometric`][@stdlib/random/streams/geometric]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a geometric distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -417,6 +425,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/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/geometric
+
+[@stdlib/random/iter/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/geometric
+
+[@stdlib/random/streams/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/geometric
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/base/negative-binomial/README.md b/lib/node_modules/@stdlib/random/base/negative-binomial/README.md
@@ -412,6 +412,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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/iter/negative-binomial`][@stdlib/random/iter/negative-binomial]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a negative binomial distribution.</span>
+-   <span class="package-name">[`@stdlib/random/streams/negative-binomial`][@stdlib/random/streams/negative-binomial]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a negative binomial distribution.</span>
+
 </section>
 
 <!-- /.related -->
@@ -424,6 +432,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/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/negative-binomial
+
+[@stdlib/random/iter/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/negative-binomial
+
+[@stdlib/random/streams/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/negative-binomial
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->