From 77bb889d11ebbc14b462ae0d2a6037a6b32093fa Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 21 Dec 2024 02:41:40 +0000 Subject: [PATCH 1/2] docs: update related packages sections --- .../@stdlib/blas/base/ccopy/README.md | 2 +- lib/node_modules/@stdlib/blas/sswap/README.md | 16 ++++++++++++++++ .../float32/max-base10-exponent/README.md | 2 -- .../@stdlib/iter/strided-by/README.md | 2 +- .../ndarray/ndarraylike2ndarray/README.md | 19 +++++++++++++++++++ .../base/reinterpret-complex64/README.md | 15 +++++++++++++++ .../@stdlib/string/base/invcase/README.md | 15 +++++++++++++++ .../string/base/remove-first/README.md | 18 ++++++++++++++++++ 8 files changed, 85 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ccopy/README.md b/lib/node_modules/@stdlib/blas/base/ccopy/README.md index 98d446dbeaca..e65ef9c5c068 100644 --- a/lib/node_modules/@stdlib/blas/base/ccopy/README.md +++ b/lib/node_modules/@stdlib/blas/base/ccopy/README.md @@ -353,7 +353,7 @@ int main( void ) { ## See Also -- [`@stdlib/blas/base/cswap`][@stdlib/blas/base/cswap]: interchanges two complex single-precision floating-point vectors. +- [`@stdlib/blas/base/cswap`][@stdlib/blas/base/cswap]: interchange two complex single-precision floating-point vectors. diff --git a/lib/node_modules/@stdlib/blas/sswap/README.md b/lib/node_modules/@stdlib/blas/sswap/README.md index 81d0baf2c3dc..441d4adebc1c 100644 --- a/lib/node_modules/@stdlib/blas/sswap/README.md +++ b/lib/node_modules/@stdlib/blas/sswap/README.md @@ -145,6 +145,14 @@ console.log( ndarray2array( y ) );
+* * * + +## See Also + +- [`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]: interchange two single-precision floating-point vectors. +- [`@stdlib/blas/dswap`][@stdlib/blas/dswap]: interchange two double-precision floating-point vectors. +- [`@stdlib/blas/gswap`][@stdlib/blas/gswap]: interchange two vectors. +
@@ -161,6 +169,14 @@ console.log( ndarray2array( y ) ); [@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap + + +[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap + +[@stdlib/blas/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/gswap + + + diff --git a/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md b/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md index e505a1e7114b..037f7c9abad3 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md +++ b/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md @@ -144,8 +144,6 @@ Macro for the maximum base 10 exponent for a [single-precision floating-point nu -[@stdlib/constants/float32/max-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent - diff --git a/lib/node_modules/@stdlib/iter/strided-by/README.md b/lib/node_modules/@stdlib/iter/strided-by/README.md index 389604e29948..ff989d86573c 100644 --- a/lib/node_modules/@stdlib/iter/strided-by/README.md +++ b/lib/node_modules/@stdlib/iter/strided-by/README.md @@ -240,7 +240,7 @@ while ( true ) { ## See Also -- [`@stdlib/iter/advance`][@stdlib/iter/advance]: advances an iterator. +- [`@stdlib/iter/advance`][@stdlib/iter/advance]: advance an iterator. - [`@stdlib/iter/nth`][@stdlib/iter/nth]: return the nth iterated value. - [`@stdlib/iter/strided`][@stdlib/iter/strided]: create an iterator which steps by a specified amount. diff --git a/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/README.md b/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/README.md index 123765907a68..728bbb6cfab8 100644 --- a/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/README.md @@ -115,6 +115,15 @@ console.log( 'order: %s', out.order );
+* * * + +## See Also + +- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays. +- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. +- [`@stdlib/ndarray/empty-like`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. +- [`@stdlib/ndarray/zeros-like`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. +
@@ -125,6 +134,16 @@ console.log( 'order: %s', out.order ); [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor + + +[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array + +[@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty-like + +[@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros-like + + + diff --git a/lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md b/lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md index 81c9a1356d4a..77fd824ac42e 100644 --- a/lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md +++ b/lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md @@ -144,6 +144,13 @@ var im = imag( z );
+* * * + +## See Also + +- [`@stdlib/strided/base/reinterpret-complex`][@stdlib/strided/base/reinterpret-complex]: reinterpret a complex-valued floating-point array as a real-valued floating-point array having the same precision. +- [`@stdlib/strided/base/reinterpret-complex128`][@stdlib/strided/base/reinterpret-complex128]: reinterpret a Complex128Array as a Float64Array. +
@@ -156,6 +163,14 @@ var im = imag( z ); [@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32 + + +[@stdlib/strided/base/reinterpret-complex]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex + +[@stdlib/strided/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex128 + + + diff --git a/lib/node_modules/@stdlib/string/base/invcase/README.md b/lib/node_modules/@stdlib/string/base/invcase/README.md index 91ae54bcf8ae..2fab0d6a205c 100644 --- a/lib/node_modules/@stdlib/string/base/invcase/README.md +++ b/lib/node_modules/@stdlib/string/base/invcase/README.md @@ -89,6 +89,13 @@ out = invcase( str );
+* * * + +## See Also + +- [`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]: convert a string to lowercase. +- [`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]: convert a string to uppercase. +
@@ -97,6 +104,14 @@ out = invcase( str );
+ + +[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase + +[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase + + +
diff --git a/lib/node_modules/@stdlib/string/base/remove-first/README.md b/lib/node_modules/@stdlib/string/base/remove-first/README.md index 425262d23296..ba71ddc24ed4 100644 --- a/lib/node_modules/@stdlib/string/base/remove-first/README.md +++ b/lib/node_modules/@stdlib/string/base/remove-first/README.md @@ -79,6 +79,14 @@ str = removeFirst( 'The Last of the Mohicans', 5 );
+* * * + +## See Also + +- [`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]: remove the first Unicode code point of a string. +- [`@stdlib/string/base/remove-first-grapheme-cluster`][@stdlib/string/base/remove-first-grapheme-cluster]: remove the first grapheme cluster (i.e., user-perceived character) of a string. +- [`@stdlib/string/base/remove-last`][@stdlib/string/base/remove-last]: remove the last UTF-16 code unit of a string. +
@@ -87,6 +95,16 @@ str = removeFirst( 'The Last of the Mohicans', 5 );
+ + +[@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-first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-grapheme-cluster + +[@stdlib/string/base/remove-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last + + +
From c70f95451cb055d886d8813eee64f03e77051109 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 20 Dec 2024 19:03:05 -0800 Subject: [PATCH 2/2] Discard changes to lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md --- .../@stdlib/constants/float32/max-base10-exponent/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md b/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md index 037f7c9abad3..e505a1e7114b 100644 --- a/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md +++ b/lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md @@ -144,6 +144,8 @@ Macro for the maximum base 10 exponent for a [single-precision floating-point nu +[@stdlib/constants/float32/max-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent +