docs: update related packages sections

stdlib-js · Jan 18, 2024 · bfe8f7e · bfe8f7e
1 parent bda78f8
commit bfe8f7e
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 2 deletions.
diff --git a/lib/node_modules/@stdlib/random/base/binomial/README.md b/lib/node_modules/@stdlib/random/base/binomial/README.md
@@ -421,6 +421,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -435,6 +443,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/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/binomial
+
+[@stdlib/random/iter/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/binomial
+
+[@stdlib/random/streams/binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/binomial
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/base/invgamma/README.md b/lib/node_modules/@stdlib/random/base/invgamma/README.md
@@ -408,6 +408,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -420,6 +428,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/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/invgamma
+
+[@stdlib/random/iter/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/invgamma
+
+[@stdlib/random/streams/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/invgamma
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/base/lognormal/README.md b/lib/node_modules/@stdlib/random/base/lognormal/README.md
@@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -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/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/lognormal
+
+[@stdlib/random/iter/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/lognormal
+
+[@stdlib/random/streams/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/lognormal
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/random/base/normal/README.md b/lib/node_modules/@stdlib/random/base/normal/README.md
@@ -402,6 +402,14 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -414,6 +422,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/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/normal
+
+[@stdlib/random/iter/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/normal
+
+[@stdlib/random/streams/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/normal
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/string/first/README.md b/lib/node_modules/@stdlib/string/first/README.md
@@ -49,7 +49,7 @@ The function supports the following options:
     -   `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
     -   `'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).
     -   `'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).
-    
+
     Default: `'grapheme'`.
 
 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 );
 
 <!-- /.notes -->
 
-
 <section class="examples">
 
 ## Examples
@@ -199,6 +198,12 @@ b
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -211,6 +216,12 @@ b
 
 [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+<!-- <related-links> -->
+
+[@stdlib/string/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/remove-first
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->