Skip to content

docs: update related packages sections #2006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions lib/node_modules/@stdlib/array/mostly-safe-casts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@ for ( i = 0; i < DTYPES.length; i++ ) {

<section class="related">

* * *

## See Also

- <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/safe-casts`][@stdlib/array/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.</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/mostly-safe-casts`][@stdlib/ndarray/mostly-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 and, for floating-point data types, can be downcast.</span>

</section>

<!-- /.related -->
Expand All @@ -131,6 +142,20 @@ for ( i = 0; i < DTYPES.length; i++ ) {

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

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

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

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

[@stdlib/array/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/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/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/mostly-safe-casts

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ bool = isNonNegativeInteger( null );
## See Also

- <span class="package-name">[`@stdlib/assert/is-integer`][@stdlib/assert/is-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having an integer value.</span>
- <span class="package-name">[`@stdlib/assert/is-nonnegative-number`][@stdlib/assert/is-nonnegative-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonnegative value.</span>
- <span class="package-name">[`@stdlib/assert/is-number`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span>

</section>

Expand All @@ -151,6 +153,10 @@ bool = isNonNegativeInteger( null );

[@stdlib/assert/is-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-integer

[@stdlib/assert/is-nonnegative-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-nonnegative-number

[@stdlib/assert/is-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-number

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

</section>
Expand Down
7 changes: 7 additions & 0 deletions lib/node_modules/@stdlib/random/array/poisson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ logEach( '%f', x4 );
## See Also

- <span class="package-name">[`@stdlib/random/base/poisson`][@stdlib/random/base/poisson]</span><span class="delimiter">: </span><span class="description">Poisson distributed random numbers.</span>
- <span class="package-name">[`@stdlib/random/strided/poisson`][@stdlib/random/strided/poisson]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Poisson distribution.</span>

</section>

Expand All @@ -374,6 +375,12 @@ logEach( '%f', x4 );

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

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

[@stdlib/random/strided/poisson]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/poisson

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

</section>

<!-- /.links -->
1 change: 0 additions & 1 deletion lib/node_modules/@stdlib/utils/any-in-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;

</section>


<!-- /.notes -->

<!-- Package usage examples. -->
Expand Down