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 Jan 19, 2024
1 parent 41f426c commit 4e8b600
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 4 deletions.
30 changes: 30 additions & 0 deletions lib/node_modules/@stdlib/array/zero-to-like/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,18 @@ console.log( idx );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/empty-like`][@stdlib/array/empty-like]</span><span class="delimiter">: </span><span class="description">create an uninitialized array having the same length and data type as a provided array.</span>
- <span class="package-name">[`@stdlib/array/full-like`][@stdlib/array/full-like]</span><span class="delimiter">: </span><span class="description">create a filled array having the same length and data type as a provided array.</span>
- <span class="package-name">[`@stdlib/array/nans-like`][@stdlib/array/nans-like]</span><span class="delimiter">: </span><span class="description">create an array filled with NaNs and having the same length and data type as a provided array.</span>
- <span class="package-name">[`@stdlib/array/one-to-like`][@stdlib/array/one-to-like]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1 starting from one and having the same length and data type as a provided input array.</span>
- <span class="package-name">[`@stdlib/array/ones-like`][@stdlib/array/ones-like]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having the same length and data type as a provided array.</span>
- <span class="package-name">[`@stdlib/array/zero-to`][@stdlib/array/zero-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1 starting from zero.</span>
- <span class="package-name">[`@stdlib/array/zeros-like`][@stdlib/array/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having the same length and data type as a provided array.</span>

</section>

<!-- /.related -->
Expand All @@ -143,6 +155,24 @@ console.log( idx );

<section class="links">

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

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/assert/is-same-complex64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ out = isSameComplex64( x, y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/assert/is-complex64`][@stdlib/assert/is-complex64]</span><span class="delimiter">: </span><span class="description">test if a value is a 64-bit complex number.</span>
- <span class="package-name">[`@stdlib/assert/is-same-complex128`][@stdlib/assert/is-same-complex128]</span><span class="delimiter">: </span><span class="description">test if two arguments are both double-precision complex floating-point numbers and have the same value.</span>
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>

</section>

<!-- /.related -->
Expand All @@ -103,6 +111,14 @@ out = isSameComplex64( x, y );

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

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

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

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

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/assert/is-same-float32array/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ out = isSameFloat32Array( x, y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/assert/is-same-float64array`][@stdlib/assert/is-same-float64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float64Arrays and have the same values.</span>
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>

</section>

<!-- /.related -->
Expand All @@ -106,6 +113,12 @@ out = isSameFloat32Array( x, y );

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

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/random/base/levy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,14 @@ for ( i = 0; i < 100; i++ ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/array/levy`][@stdlib/random/array/levy]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Lévy distribution.</span>
- <span class="package-name">[`@stdlib/random/iter/levy`][@stdlib/random/iter/levy]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Lévy distribution.</span>
- <span class="package-name">[`@stdlib/random/streams/levy`][@stdlib/random/streams/levy]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Lévy distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -413,6 +421,16 @@ for ( i = 0; i < 100; i++ ) {

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

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

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

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

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

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

</section>

<!-- /.links -->
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/random/strided/uniform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,14 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/random/base/uniform`][@stdlib/random/base/uniform]</span><span class="delimiter">: </span><span class="description">uniformly distributed pseudorandom numbers.</span>
- <span class="package-name">[`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
- <span class="package-name">[`@stdlib/random/strided/discrete-uniform`][@stdlib/random/strided/discrete-uniform]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a discrete uniform distribution.</span>

</section>

<!-- /.related -->
Expand All @@ -221,6 +229,14 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

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

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

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

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

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

</section>

<!-- /.links -->
4 changes: 0 additions & 4 deletions lib/node_modules/@stdlib/stats/base/stdevpn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,8 @@ console.log( v );

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

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

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

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

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

[@stdlib/stats/base/variancepn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/variancepn
Expand Down

0 comments on commit 4e8b600

Please sign in to comment.