From 063502b40795caeafe627c83272f584ceef6845b Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 13 Mar 2024 02:23:01 +0000 Subject: [PATCH] docs: update related packages sections --- lib/node_modules/@stdlib/array/mskreject/README.md | 12 ++++++++++++ lib/node_modules/@stdlib/array/safe-casts/README.md | 3 +++ .../@stdlib/math/base/special/csch/README.md | 4 ++-- .../@stdlib/utils/every-own-by/README.md | 3 --- .../@stdlib/utils/parse-ndjson/README.md | 3 +-- 5 files changed, 18 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/array/mskreject/README.md b/lib/node_modules/@stdlib/array/mskreject/README.md index cbafb6172f7..2a7565e534a 100644 --- a/lib/node_modules/@stdlib/array/mskreject/README.md +++ b/lib/node_modules/@stdlib/array/mskreject/README.md @@ -95,6 +95,12 @@ console.log( y );
+* * * + +## See Also + +- [`@stdlib/array/mskfilter`][@stdlib/array/mskfilter]: apply a mask to a provided input array. +
@@ -105,6 +111,12 @@ console.log( y ); [@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dtypes + + +[@stdlib/array/mskfilter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskfilter + + + diff --git a/lib/node_modules/@stdlib/array/safe-casts/README.md b/lib/node_modules/@stdlib/array/safe-casts/README.md index 04ef1662bce..4a6363e934b 100644 --- a/lib/node_modules/@stdlib/array/safe-casts/README.md +++ b/lib/node_modules/@stdlib/array/safe-casts/README.md @@ -128,6 +128,7 @@ for ( i = 0; i < DTYPES.length; i++ ) { - [`@stdlib/array/convert`][@stdlib/array/convert]: convert an array to an array of a different data type. - [`@stdlib/array/convert-same`][@stdlib/array/convert-same]: convert an array to the same data type as a second input array. - [`@stdlib/array/dtypes`][@stdlib/array/dtypes]: list of array data types. +- [`@stdlib/array/mostly-safe-casts`][@stdlib/array/mostly-safe-casts]: return a list of array data types to which a provided array data type can be safely cast and, for floating-point data types, can be downcast. - [`@stdlib/array/same-kind-casts`][@stdlib/array/same-kind-casts]: return a list of array data types to which a provided array data type can be safely cast or cast within the same kind. - [`@stdlib/ndarray/safe-casts`][@stdlib/ndarray/safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast. @@ -147,6 +148,8 @@ for ( i = 0; i < DTYPES.length; i++ ) { [@stdlib/array/convert-same]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/convert-same +[@stdlib/array/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mostly-safe-casts + [@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/same-kind-casts [@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/safe-casts diff --git a/lib/node_modules/@stdlib/math/base/special/csch/README.md b/lib/node_modules/@stdlib/math/base/special/csch/README.md index 83fbee39e41..8eef55c74b4 100644 --- a/lib/node_modules/@stdlib/math/base/special/csch/README.md +++ b/lib/node_modules/@stdlib/math/base/special/csch/README.md @@ -171,7 +171,7 @@ int main( void ) { ## See Also - [`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]: compute the hyperbolic arccosecant of a number. -- [`@stdlib/math/base/special/csch`][@stdlib/math/base/special/csch]: compute the hyperbolic cotangent of a number. +- [`@stdlib/math/base/special/coth`][@stdlib/math/base/special/coth]: compute the hyperbolic cotangent of a number. - [`@stdlib/math/base/special/sinh`][@stdlib/math/base/special/sinh]: compute the hyperbolic sine of a double-precision floating-point number. @@ -188,7 +188,7 @@ int main( void ) { [@stdlib/math/base/special/acsch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acsch -[@stdlib/math/base/special/csch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csch +[@stdlib/math/base/special/coth]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/coth [@stdlib/math/base/special/sinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sinh diff --git a/lib/node_modules/@stdlib/utils/every-own-by/README.md b/lib/node_modules/@stdlib/utils/every-own-by/README.md index d3eb43ddfcf..dcc46a484d8 100644 --- a/lib/node_modules/@stdlib/utils/every-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/every-own-by/README.md @@ -137,7 +137,6 @@ var mean = context.sum / context.count; // returns true ``` - @@ -186,7 +185,6 @@ var bool = everyOwnBy( obj, isPositive );
-
@@ -199,7 +197,6 @@ var bool = everyOwnBy( obj, isPositive ); - diff --git a/lib/node_modules/@stdlib/utils/parse-ndjson/README.md b/lib/node_modules/@stdlib/utils/parse-ndjson/README.md index b5ef9009696..d93c24e8f56 100644 --- a/lib/node_modules/@stdlib/utils/parse-ndjson/README.md +++ b/lib/node_modules/@stdlib/utils/parse-ndjson/README.md @@ -100,12 +100,11 @@ var out = parseNDJSON( str, reviver ); ```javascript var out = JSON.parse( '{"a":"b"}', [] ); // returns { 'a': 'b' } - + out = parseNDJSON( '{"a":"b"}', [] ); // throws ``` -