docs: update related packages sections

PR-URL: #3915 Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Dec 15, 2024 · b8c41df · b8c41df · stdlib-bot · Dec 15, 2024
1 parent e43aaa9
commit b8c41df
Show file tree

Hide file tree

Showing 13 changed files with 154 additions and 3 deletions.
diff --git a/lib/node_modules/@stdlib/array/base/flatten2d-by/README.md b/lib/node_modules/@stdlib/array/base/flatten2d-by/README.md
@@ -185,6 +185,12 @@ out = flatten2dBy( x, [ 4, 4 ], true, fcn );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/base/flatten2d`][@stdlib/array/base/flatten2d]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array.</span>
+
 </section>
 
 <!-- /.related -->
@@ -193,6 +199,12 @@ out = flatten2dBy( x, [ 4, 4 ], true, fcn );
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/array/base/flatten2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/assert/has-atob-support/README.md b/lib/node_modules/@stdlib/assert/has-atob-support/README.md
@@ -108,6 +108,12 @@ $ has-atob-support
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/has-btoa-support`][@stdlib/assert/has-btoa-support]</span><span class="delimiter">: </span><span class="description">detect native btoa support.</span>
+
 </section>
 
 <!-- /.related -->
@@ -118,6 +124,12 @@ $ has-atob-support
 
 [mdn-atob]: https://developer.mozilla.org/en-US/docs/Web/API/Window/atob
 
+<!-- <related-links> -->
+
+[@stdlib/assert/has-btoa-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-btoa-support
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/assert/is-ndarray-like-with-data-type/README.md b/lib/node_modules/@stdlib/assert/is-ndarray-like-with-data-type/README.md
@@ -78,6 +78,12 @@ bool = isndarrayLikeWithDataType( null, 'generic' );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-ndarray-like`][@stdlib/assert/is-ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is ndarray-like.</span>
+
 </section>
 
 <!-- /.related -->

diff --git a/lib/node_modules/@stdlib/blas/base/dscal/README.md b/lib/node_modules/@stdlib/blas/base/dscal/README.md
@@ -281,10 +281,10 @@ int main( void ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
+-   <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
 -   <span class="package-name">[`@stdlib/blas/base/gscal`][@stdlib/blas/base/gscal]</span><span class="delimiter">: </span><span class="description">multiply a vector by a constant.</span>
 -   <span class="package-name">[`@stdlib/blas/base/sscal`][@stdlib/blas/base/sscal]</span><span class="delimiter">: </span><span class="description">multiply a single-precision floating-point vector by a constant.</span>
--   <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
+-   <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
 
 </section>
 

diff --git a/lib/node_modules/@stdlib/blas/base/sswap/README.md b/lib/node_modules/@stdlib/blas/base/sswap/README.md
@@ -304,6 +304,15 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/blas/base/dswap`][@stdlib/blas/base/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
+-   <span class="package-name">[`@stdlib/blas/base/gswap`][@stdlib/blas/base/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
+-   <span class="package-name">[`@stdlib/blas/base/scopy`][@stdlib/blas/base/scopy]</span><span class="delimiter">: </span><span class="description">copy values from x into y.</span>
+-   <span class="package-name">[`@stdlib/blas/sswap`][@stdlib/blas/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
+
 </section>
 
 <!-- /.related -->
@@ -320,6 +329,18 @@ int main( void ) {
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+<!-- <related-links> -->
+
+[@stdlib/blas/base/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dswap
+
+[@stdlib/blas/base/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/gswap
+
+[@stdlib/blas/base/scopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/scopy
+
+[@stdlib/blas/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/sswap
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/constants/float64/high-word-significand-mask/README.md b/lib/node_modules/@stdlib/constants/float64/high-word-significand-mask/README.md
@@ -150,6 +150,8 @@ Macro for the high word mask for the significand of a [double-precision floating
 ## See Also
 
 -   <span class="package-name">[`@stdlib/constants/float64/high-word-exponent-mask`][@stdlib/constants/float64/high-word-exponent-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the exponent of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/constants/float64/high-word-sign-mask`][@stdlib/constants/float64/high-word-sign-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the sign bit of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]</span><span class="delimiter">: </span><span class="description">high word mask for excluding the sign bit of a double-precision floating-point number.</span>
 
 </section>
 
@@ -165,6 +167,10 @@ Macro for the high word mask for the significand of a [double-precision floating
 
 [@stdlib/constants/float64/high-word-exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-exponent-mask
 
+[@stdlib/constants/float64/high-word-sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-sign-mask
+
+[@stdlib/constants/float64/high-word-abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-abs-mask
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/math/base/special/acosf/README.md b/lib/node_modules/@stdlib/math/base/special/acosf/README.md
@@ -173,6 +173,15 @@ int main( void ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/acos`][@stdlib/math/base/special/acos]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/acosh`][@stdlib/math/base/special/acosh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosine of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/asinf`][@stdlib/math/base/special/asinf]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a single-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/atanf`][@stdlib/math/base/special/atanf]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a single-precision floating-point number.</span>
+
 </section>
 
 <!-- /.related -->
@@ -183,6 +192,18 @@ int main( void ) {
 
 [arccosine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
 
+<!-- <related-links> -->
+
+[@stdlib/math/base/special/acos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acos
+
+[@stdlib/math/base/special/acosh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosh
+
+[@stdlib/math/base/special/asinf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinf
+
+[@stdlib/math/base/special/atanf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanf
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/math/strided/ops/mul-by/README.md b/lib/node_modules/@stdlib/math/strided/ops/mul-by/README.md
@@ -241,6 +241,14 @@ console.log( z );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/strided/ops/mul`][@stdlib/math/strided/ops/mul]</span><span class="delimiter">: </span><span class="description">element-wise multiplication of two strided arrays.</span>
+-   <span class="package-name">[`@stdlib/math/strided/ops/add-by`][@stdlib/math/strided/ops/add-by]</span><span class="delimiter">: </span><span class="description">element-wise addition of two strided arrays via a callback function.</span>
+-   <span class="package-name">[`@stdlib/math/strided/ops/sub-by`][@stdlib/math/strided/ops/sub-by]</span><span class="delimiter">: </span><span class="description">element-wise subtraction of two strided arrays via a callback function.</span>
+
 </section>
 
 <!-- /.related -->
@@ -255,6 +263,16 @@ console.log( z );
 
 [@stdlib/math/base/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul
 
+<!-- <related-links> -->
+
+[@stdlib/math/strided/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/mul
+
+[@stdlib/math/strided/ops/add-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/add-by
+
+[@stdlib/math/strided/ops/sub-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/sub-by
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/regexp/semver/README.md b/lib/node_modules/@stdlib/regexp/semver/README.md
@@ -142,6 +142,12 @@ bool = RE_SEMVER.test( version );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-semver`][@stdlib/assert/is-semver]</span><span class="delimiter">: </span><span class="description">test if a value is a semantic version string.</span>
+
 </section>
 
 <!-- /.related -->
@@ -156,6 +162,8 @@ bool = RE_SEMVER.test( version );
 
 <!-- <related-links> -->
 
+[@stdlib/assert/is-semver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-semver
+
 <!-- </related-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/slice/base/int2slice/README.md b/lib/node_modules/@stdlib/slice/base/int2slice/README.md
@@ -128,6 +128,13 @@ console.log( '%s', s.toString() );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/slice/base/seq2slice`][@stdlib/slice/base/seq2slice]</span><span class="delimiter">: </span><span class="description">convert a subsequence string to a Slice object.</span>
+-   <span class="package-name">[`@stdlib/slice/base/str2slice`][@stdlib/slice/base/str2slice]</span><span class="delimiter">: </span><span class="description">parse a string-serialized Slice object.</span>
+
 </section>
 
 <!-- /.related -->
@@ -138,6 +145,14 @@ console.log( '%s', s.toString() );
 
 [@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2slice
+
+[@stdlib/slice/base/str2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2slice
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md
@@ -270,4 +270,3 @@ int main( void ) {
 </section>
 
 <!-- /.links -->
-
diff --git a/lib/node_modules/@stdlib/string/base/left-trim/README.md b/lib/node_modules/@stdlib/string/base/left-trim/README.md
@@ -96,6 +96,13 @@ str = ltrim( '\n\n\nNew Lines\n\n\n' );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/string/base/right-trim`][@stdlib/string/base/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>
+-   <span class="package-name">[`@stdlib/string/base/trim`][@stdlib/string/base/trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning and end of a string.</span>
+
 </section>
 
 <!-- /.related -->
@@ -106,6 +113,14 @@ str = ltrim( '\n\n\nNew Lines\n\n\n' );
 
 [unicode]: https://en.wikipedia.org/wiki/Unicode
 
+<!-- <related-links> -->
+
+[@stdlib/string/base/right-trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/right-trim
+
+[@stdlib/string/base/trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/trim
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/lib/node_modules/@stdlib/string/base/remove-first-grapheme-cluster/README.md b/lib/node_modules/@stdlib/string/base/remove-first-grapheme-cluster/README.md
@@ -91,6 +91,14 @@ str = removeFirstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove the first Unicode code point of a string.</span>
+-   <span class="package-name">[`@stdlib/string/base/remove-last-grapheme-cluster`][@stdlib/string/base/remove-last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the last grapheme cluster (i.e., user-perceived character) of a string.</span>
+-   <span class="package-name">[`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first UTF-16 code unit of a string.</span>
+
 </section>
 
 <!-- /.related -->
@@ -99,6 +107,16 @@ str = removeFirstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/string/base/remove-first-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-code-point
+
+[@stdlib/string/base/remove-last-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last-grapheme-cluster
+
+[@stdlib/string/base/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
Original file line number	Diff line number	Diff line change
Expand Up		@@ -270,4 +270,3 @@ int main( void ) {
		</section>

		<!-- /.links -->
Package	Statements	Branches	Functions	Lines
array/base/flatten2d-by	$\color{green}275/275$ $\color{green}+100.00\%$	$\color{green}15/15$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}275/275$ $\color{green}+100.00\%$
assert/has-atob-support	$\color{green}131/131$ $\color{green}+100.00\%$	$\color{red}7/8$ $\color{green}+87.50\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}131/131$ $\color{green}+100.00\%$
assert/is-ndarray-like-with-data-type	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$
blas/base/dscal	$\color{green}389/389$ $\color{green}+100.00\%$	$\color{green}26/26$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}389/389$ $\color{green}+100.00\%$
blas/base/sswap	$\color{green}429/429$ $\color{green}+100.00\%$	$\color{green}28/28$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}429/429$ $\color{green}+100.00\%$
constants/float64/high-word-significand-mask	$\color{green}56/56$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}56/56$ $\color{green}+100.00\%$
math/base/special/acosf	$\color{red}291/293$ $\color{green}+99.32\%$	$\color{red}21/22$ $\color{green}+95.45\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{red}291/293$ $\color{green}+99.32\%$
math/strided/ops/mul-by	$\color{green}206/206$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}206/206$ $\color{green}+100.00\%$
regexp/semver	$\color{green}184/184$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}184/184$ $\color{green}+100.00\%$
slice/base/int2slice	$\color{green}165/165$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}165/165$ $\color{green}+100.00\%$
stats/base/dists/arcsine/logpdf	$\color{green}293/293$ $\color{green}+100.00\%$	$\color{green}25/25$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}293/293$ $\color{green}+100.00\%$
string/base/left-trim	$\color{green}320/320$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}320/320$ $\color{green}+100.00\%$
string/base/remove-first-grapheme-cluster	$\color{green}121/121$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}121/121$ $\color{green}+100.00\%$