From b8c41df78cd2cdc9cd3c3c6b223759d32f4f6e14 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 14 Dec 2024 19:37:03 -0800 Subject: [PATCH] docs: update related packages sections PR-URL: https://github.com/stdlib-js/stdlib/pull/3915 Reviewed-by: Philipp Burckhardt --- .../@stdlib/array/base/flatten2d-by/README.md | 12 +++++++++++ .../@stdlib/assert/has-atob-support/README.md | 12 +++++++++++ .../is-ndarray-like-with-data-type/README.md | 6 ++++++ .../@stdlib/blas/base/dscal/README.md | 4 ++-- .../@stdlib/blas/base/sswap/README.md | 21 +++++++++++++++++++ .../high-word-significand-mask/README.md | 6 ++++++ .../@stdlib/math/base/special/acosf/README.md | 21 +++++++++++++++++++ .../@stdlib/math/strided/ops/mul-by/README.md | 18 ++++++++++++++++ .../@stdlib/regexp/semver/README.md | 8 +++++++ .../@stdlib/slice/base/int2slice/README.md | 15 +++++++++++++ .../stats/base/dists/arcsine/logpdf/README.md | 1 - .../@stdlib/string/base/left-trim/README.md | 15 +++++++++++++ .../remove-first-grapheme-cluster/README.md | 18 ++++++++++++++++ 13 files changed, 154 insertions(+), 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 index 1184476ef47a..c183ce8af777 100644 --- 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 ); @@ -193,6 +199,12 @@ out = flatten2dBy( x, [ 4, 4 ], true, fcn ); diff --git a/lib/node_modules/@stdlib/assert/has-atob-support/README.md b/lib/node_modules/@stdlib/assert/has-atob-support/README.md index ddf242509626..33f477e444eb 100644 --- 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 @@ -118,6 +124,12 @@ $ has-atob-support [mdn-atob]: https://developer.mozilla.org/en-US/docs/Web/API/Window/atob + + +[@stdlib/assert/has-btoa-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-btoa-support + + + 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 index 60e93a6aaa99..8a6d2cbf6b68 100644 --- 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' ); diff --git a/lib/node_modules/@stdlib/blas/base/dscal/README.md b/lib/node_modules/@stdlib/blas/base/dscal/README.md index 0716abd284be..30297bdedbd9 100644 --- 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 -- [`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]: multiply a vector x by a constant and add the result to y. +- [`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]: multiply a vector `x` by a constant and add the result to `y`. - [`@stdlib/blas/base/gscal`][@stdlib/blas/base/gscal]: multiply a vector by a constant. - [`@stdlib/blas/base/sscal`][@stdlib/blas/base/sscal]: multiply a single-precision floating-point vector by a constant. -- [`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]: multiply a vector x by a constant and add the result to y. +- [`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]: multiply a vector `x` by a constant and add the result to `y`. diff --git a/lib/node_modules/@stdlib/blas/base/sswap/README.md b/lib/node_modules/@stdlib/blas/base/sswap/README.md index c93c69742ef2..bb81dfb811f2 100644 --- 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 ) { @@ -320,6 +329,18 @@ int main( void ) { [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + + +[@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 + + + 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 index 5e82e671c77c..f2f4053534b5 100644 --- 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 - [`@stdlib/constants/float64/high-word-exponent-mask`][@stdlib/constants/float64/high-word-exponent-mask]: high word mask for the exponent of a double-precision floating-point number. +- [`@stdlib/constants/float64/high-word-sign-mask`][@stdlib/constants/float64/high-word-sign-mask]: high word mask for the sign bit of a double-precision floating-point number. +- [`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]: high word mask for excluding the sign bit of a double-precision floating-point number. @@ -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 + diff --git a/lib/node_modules/@stdlib/math/base/special/acosf/README.md b/lib/node_modules/@stdlib/math/base/special/acosf/README.md index 5ba6c4bb774f..5331b5511b09 100644 --- 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 ) { @@ -183,6 +192,18 @@ int main( void ) { [arccosine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions + + +[@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 + + + 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 index d0267fa08dce..ba8a5630bc21 100644 --- 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 ); @@ -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 + + +[@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 + + + diff --git a/lib/node_modules/@stdlib/regexp/semver/README.md b/lib/node_modules/@stdlib/regexp/semver/README.md index 38806acdd0a9..3c02c2a9ede8 100644 --- 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 ); @@ -156,6 +162,8 @@ bool = RE_SEMVER.test( version ); +[@stdlib/assert/is-semver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-semver + diff --git a/lib/node_modules/@stdlib/slice/base/int2slice/README.md b/lib/node_modules/@stdlib/slice/base/int2slice/README.md index 8d49ffddd3d1..6512b2eb442d 100644 --- 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() ); @@ -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 + + +[@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 + + + 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 index 3fd6981d6646..b3a3618319f3 100644 --- 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 ) { - diff --git a/lib/node_modules/@stdlib/string/base/left-trim/README.md b/lib/node_modules/@stdlib/string/base/left-trim/README.md index f51c1ad3a5a0..28f4c152e391 100644 --- 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' ); @@ -106,6 +113,14 @@ str = ltrim( '\n\n\nNew Lines\n\n\n' ); [unicode]: https://en.wikipedia.org/wiki/Unicode + + +[@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 + + + 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 index d35e9dcc74ad..02e28b1a70c4 100644 --- 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 ); @@ -99,6 +107,16 @@ str = removeFirstGraphemeCluster( '🐶🐮🐷🐰🐸', 10 );