docs: update related packages sections

PR-URL: #1276 Reviewed-by: Athan Reines <[email protected]>
stdlib-js · Jan 21, 2024 · f04074a · f04074a · stdlib-bot · Jan 21, 2024
1 parent 2e71bed
commit f04074a
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 4 deletions.
diff --git a/lib/node_modules/@stdlib/constants/complex64/nan/README.md b/lib/node_modules/@stdlib/constants/complex64/nan/README.md
@@ -93,12 +93,26 @@ im = imagf( v );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/constants/complex128/nan`][@stdlib/constants/complex128/nan]</span><span class="delimiter">: </span><span class="description">canonical double-precision complex floating-point NaN.</span>
+
+</section>
+
 <!-- /.related -->
 
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/constants/complex128/nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/complex128/nan
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/ndarray/dispatch/README.md b/lib/node_modules/@stdlib/ndarray/dispatch/README.md
@@ -274,8 +274,6 @@ console.log( ybuf );
 
 <!-- <related-links> -->
 
-
-
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/ndarray/numel/README.md b/lib/node_modules/@stdlib/ndarray/numel/README.md
@@ -136,6 +136,7 @@ for ( i = 0; i < slices.length; i++ ) {
 
 -   <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
 -   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <span class="package-name">[`@stdlib/ndarray/numel-dimension`][@stdlib/ndarray/numel-dimension]</span><span class="delimiter">: </span><span class="description">return the size (i.e., number of elements) of a specified dimension for a provided ndarray.</span>
 
 </section>
 
@@ -151,6 +152,8 @@ for ( i = 0; i < slices.length; i++ ) {
 
 [@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
 
+[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel-dimension
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/random/array/triangular/README.md b/lib/node_modules/@stdlib/random/array/triangular/README.md
@@ -356,6 +356,12 @@ logEach( '%f', x4 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/base/triangular`][@stdlib/random/base/triangular]</span><span class="delimiter">: </span><span class="description">triangular distributed pseudorandom numbers.</span>
+
 </section>
 
 <!-- /.related -->

diff --git a/lib/node_modules/@stdlib/random/base/box-muller/README.md b/lib/node_modules/@stdlib/random/base/box-muller/README.md
@@ -422,6 +422,13 @@ for ( i = 0; i < 100; i++ ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/random/iter/box-muller`][@stdlib/random/iter/box-muller]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span>
+-   <span class="package-name">[`@stdlib/random/streams/box-muller`][@stdlib/random/streams/box-muller]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span>
+
 </section>
 
 <!-- /.related -->
@@ -444,6 +451,14 @@ 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/iter/box-muller]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/box-muller
+
+[@stdlib/random/streams/box-muller]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/box-muller
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/slice/multi/README.md b/lib/node_modules/@stdlib/slice/multi/README.md
@@ -251,8 +251,6 @@ console.log( JSON.stringify( o ) );
 
 <!-- <related-links> -->
 
-
-
 <!-- </related-links> -->
 
 </section>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -274,8 +274,6 @@ console.log( ybuf );

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



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

		</section>
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -251,8 +251,6 @@ console.log( JSON.stringify( o ) );

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



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

		</section>
Expand Down
Package	Statements	Branches	Functions	Lines
constants/complex64/nan	$\color{green}50/50$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}50/50$ $\color{green}+100.00\%$
ndarray/dispatch	$\color{green}399/399$ $\color{green}+100.00\%$	$\color{green}63/63$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}399/399$ $\color{green}+100.00\%$
ndarray/numel	$\color{red}119/122$ $\color{green}+97.54\%$	$\color{red}15/16$ $\color{green}+93.75\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{red}119/122$ $\color{green}+97.54\%$
random/array/triangular	$\color{green}215/215$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}215/215$ $\color{green}+100.00\%$
random/base/box-muller	$\color{green}563/563$ $\color{green}+100.00\%$	$\color{green}50/50$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}563/563$ $\color{green}+100.00\%$
slice/multi	$\color{red}323/325$ $\color{green}+99.38\%$	$\color{red}35/36$ $\color{green}+97.22\%$	$\color{green}6/6$ $\color{green}+100.00\%$	$\color{red}323/325$ $\color{green}+99.38\%$