Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Mar 13, 2024
1 parent 7bce237 commit 063502b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 7 deletions.
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/mskreject/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,12 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/mskfilter`][@stdlib/array/mskfilter]</span><span class="delimiter">: </span><span class="description">apply a mask to a provided input array.</span>

</section>

<!-- /.related -->
Expand All @@ -105,6 +111,12 @@ console.log( y );

[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dtypes

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

[@stdlib/array/mskfilter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskfilter

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

</section>

<!-- /.links -->
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/array/safe-casts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ for ( i = 0; i < DTYPES.length; i++ ) {
- <span class="package-name">[`@stdlib/array/convert`][@stdlib/array/convert]</span><span class="delimiter">: </span><span class="description">convert an array to an array of a different data type.</span>
- <span class="package-name">[`@stdlib/array/convert-same`][@stdlib/array/convert-same]</span><span class="delimiter">: </span><span class="description">convert an array to the same data type as a second input array.</span>
- <span class="package-name">[`@stdlib/array/dtypes`][@stdlib/array/dtypes]</span><span class="delimiter">: </span><span class="description">list of array data types.</span>
- <span class="package-name">[`@stdlib/array/mostly-safe-casts`][@stdlib/array/mostly-safe-casts]</span><span class="delimiter">: </span><span class="description">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.</span>
- <span class="package-name">[`@stdlib/array/same-kind-casts`][@stdlib/array/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of array data types to which a provided array data type can be safely cast or cast within the same kind.</span>
- <span class="package-name">[`@stdlib/ndarray/safe-casts`][@stdlib/ndarray/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/csch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ int main( void ) {
## See Also

- <span class="package-name">[`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/csch`][@stdlib/math/base/special/csch]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic cotangent of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/coth`][@stdlib/math/base/special/coth]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic cotangent of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/sinh`][@stdlib/math/base/special/sinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic sine of a double-precision floating-point number.</span>

</section>
Expand All @@ -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

Expand Down
3 changes: 0 additions & 3 deletions lib/node_modules/@stdlib/utils/every-own-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ var mean = context.sum / context.count;
// returns true
```


</section>

<!-- /.notes -->
Expand Down Expand Up @@ -186,7 +185,6 @@ var bool = everyOwnBy( obj, isPositive );

<section class="related">


</section>

<!-- /.related -->
Expand All @@ -199,7 +197,6 @@ var bool = everyOwnBy( obj, isPositive );

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


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

</section>
Expand Down
3 changes: 1 addition & 2 deletions lib/node_modules/@stdlib/utils/parse-ndjson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,11 @@ var out = parseNDJSON( str, reviver );
```javascript
var out = JSON.parse( '{"a":"b"}', [] );
// returns { 'a': 'b' }

out = parseNDJSON( '{"a":"b"}', [] );
// throws <TypeError>
```


</section>

<!-- /.notes -->
Expand Down

0 comments on commit 063502b

Please sign in to comment.