Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
PR-URL: 	#1361
Reviewed-by: Athan Reines <kgryte@gmail.com>
  • Loading branch information
stdlib-bot authored Feb 24, 2024
1 parent 1650684 commit 1dc5966
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 4 deletions.
10 changes: 8 additions & 2 deletions lib/node_modules/@stdlib/array/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ var o = idx.toJSON();

```javascript
var Uint8Array = require( '@stdlib/array/uint8' );

var data = new Uint8Array( [ 1, 0, 0, 0 ] );
var idx = new ArrayIndex( data );

Expand All @@ -365,7 +365,7 @@ var o = idx.toJSON();

```javascript
var Uint8Array = require( '@stdlib/array/uint8' );
var data = new Uint8Array( [ 1, 0, 0, 0 ] );
var idx = new ArrayIndex( data );
Expand Down Expand Up @@ -452,6 +452,12 @@ console.log( 'Type: %s. Data type: %s.', o.type, o.dtype );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/to-fancy`][@stdlib/array/to-fancy]</span><span class="delimiter">: </span><span class="description">convert an array to an object supporting fancy indexing.</span>

</section>

<!-- /.related -->
Expand Down
2 changes: 0 additions & 2 deletions lib/node_modules/@stdlib/blas/base/gcopy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,6 @@ console.log( y );

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



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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/nan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,12 @@ Macro for [double-precision floating-point][ieee754] NaN.

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/nan`][@stdlib/constants/float32/nan]</span><span class="delimiter">: </span><span class="description">single-precision floating-point NaN.</span>

</section>

<!-- /.related -->
Expand All @@ -130,6 +136,12 @@ Macro for [double-precision floating-point][ieee754] NaN.

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

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

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

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

</section>

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

<section class="related">

* * *

## See Also

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

</section>

<!-- /.related -->
Expand All @@ -421,6 +429,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/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/betaprime

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

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

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

</section>

<!-- /.links -->

1 comment on commit 1dc5966

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/index $\color{green}733/733$
$\color{green}+100.00\%$
$\color{green}72/72$
$\color{green}+100.00\%$
$\color{green}14/14$
$\color{green}+100.00\%$
$\color{green}733/733$
$\color{green}+100.00\%$
blas/base/gcopy $\color{green}394/394$
$\color{green}+100.00\%$
$\color{green}47/47$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}394/394$
$\color{green}+100.00\%$
constants/float64/nan $\color{green}48/48$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}48/48$
$\color{green}+100.00\%$
random/base/betaprime $\color{green}458/458$
$\color{green}+100.00\%$
$\color{green}47/47$
$\color{green}+100.00\%$
$\color{green}12/12$
$\color{green}+100.00\%$
$\color{green}458/458$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.