Skip to content

docs: update related packages sections #3380

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
Dec 9, 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
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/array/bool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1833,6 +1833,12 @@ console.log( '%s', false );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/buffer`][@stdlib/array/buffer]</span><span class="delimiter">: </span><span class="description">ArrayBuffer.</span>

</section>

<!-- /.related -->
Expand Down
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/array/fixed-endian-float64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,13 @@ logEach( '%s', out );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/fixed-endian-float32`][@stdlib/array/fixed-endian-float32]</span><span class="delimiter">: </span><span class="description">Float32Array having a specified byte order.</span>
- <span class="package-name">[`@stdlib/array/float64`][@stdlib/array/float64]</span><span class="delimiter">: </span><span class="description">Float64Array.</span>

</section>

<!-- /.related -->
Expand All @@ -438,6 +445,12 @@ logEach( '%s', out );

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

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/mskput/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@ console.log( out );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/place`][@stdlib/array/place]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
- <span class="package-name">[`@stdlib/array/put`][@stdlib/array/put]</span><span class="delimiter">: </span><span class="description">replace specified elements of an array with provided values.</span>
- <span class="package-name">[`@stdlib/array/take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>

</section>

<!-- /.related -->
Expand All @@ -160,6 +168,16 @@ console.log( out );

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

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

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

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/put/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,14 @@ console.log( out );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/mskput`][@stdlib/array/mskput]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
- <span class="package-name">[`@stdlib/array/place`][@stdlib/array/place]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
- <span class="package-name">[`@stdlib/array/take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>

</section>

<!-- /.related -->
Expand All @@ -165,6 +173,16 @@ console.log( out );

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

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

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

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

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

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

</section>

<!-- /.links -->
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/blas/sdot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,14 @@ console.log( ndarray2array( z ) );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/blas/base/sdot`][@stdlib/blas/base/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/ddot`][@stdlib/blas/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/gdot`][@stdlib/blas/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two vectors.</span>

</section>

<!-- /.related -->
Expand All @@ -172,6 +180,14 @@ console.log( ndarray2array( z ) );

[@stdlib/blas/base/sdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sdot

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

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

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

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,14 @@ Macro for the mask for the significand of a [single-precision floating-point num

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/exponent-mask`][@stdlib/constants/float32/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float32/sign-mask`][@stdlib/constants/float32/sign-mask]</span><span class="delimiter">: </span><span class="description">mask for the sign bit of a single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]</span><span class="delimiter">: </span><span class="description">mask for excluding the sign bit of a single-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -149,6 +157,16 @@ Macro for the mask for the significand of a [single-precision floating-point num

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask

[@stdlib/constants/float32/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sign-mask

[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask

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

</section>

<!-- /.links -->
17 changes: 17 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/acosd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,15 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/acos`][@stdlib/math/base/special/acos]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/acosh`][@stdlib/math/base/special/acosh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asind`][@stdlib/math/base/special/asind]</span><span class="delimiter">: </span><span class="description">compute the arcsine (in degrees) of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]</span><span class="delimiter">: </span><span class="description">compute the arctangent(in degrees) of a double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -189,6 +198,14 @@ int main( void ) {

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

[@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/asind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asind

[@stdlib/math/base/special/atand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atand

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

</section>
Expand Down
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/rcbrtf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,13 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/rcbrt`][@stdlib/math/base/special/rcbrt]</span><span class="delimiter">: </span><span class="description">compute the reciprocal cube root of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/cbrtf`][@stdlib/math/base/special/cbrtf]</span><span class="delimiter">: </span><span class="description">compute the cube root of a single-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -202,6 +209,10 @@ int main( void ) {

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

[@stdlib/math/base/special/rcbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/rcbrt

[@stdlib/math/base/special/cbrtf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrtf

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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/math/strided/special/asin-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,12 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/strided/special/asinh-by`][@stdlib/math/strided/special/asinh-by]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of each element retrieved from an input strided array via a callback function.</span>

</section>

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

[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin

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

[@stdlib/math/strided/special/asinh-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/asinh-by

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/slice/base/normalize-slice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/slice/base/normalize-multi-slice`][@stdlib/slice/base/normalize-multi-slice]</span><span class="delimiter">: </span><span class="description">normalize a MultiSlice object.</span>

</section>

<!-- /.related -->
Expand All @@ -146,6 +152,12 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );

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

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

[@stdlib/slice/base/normalize-multi-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/normalize-multi-slice

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/strided/base/dtype-str2enum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,12 @@ v = str2enum( 'uint8' );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/strided/base/dtype-enum2str`][@stdlib/strided/base/dtype-enum2str]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a strided array data type enumeration constant.</span>

</section>

<!-- /.related -->
Expand All @@ -132,6 +138,12 @@ v = str2enum( 'uint8' );

<section class="links">

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

[@stdlib/strided/base/dtype-enum2str]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dtype-enum2str

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,6 @@ f( 5, 3, done );

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

[@stdlib/utils/async/compose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/compose

[@stdlib/utils/function-sequence]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/function-sequence

<!-- </related-links> -->
Expand Down
Loading