Skip to content

docs: update namespace table of contents #6917

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.

Sign up for GitHub

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
May 4, 2025
+18 −0
Merged

docs: update namespace table of contents #6917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/random/array/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ The namespace contains the following:
- <span class="signature">[`randu( len[, options] )`][@stdlib/random/array/randu]</span><span class="delimiter">: </span><span class="description">create an array containing uniformly distributed pseudorandom numbers between `0` and `1`.</span>
- <span class="signature">[`rayleigh( len, sigma[, options] )`][@stdlib/random/array/rayleigh]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Rayleigh distribution.</span>
- <span class="signature">[`t( len, v[, options] )`][@stdlib/random/array/t]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Student's t-distribution.</span>
- <span class="signature">[`tools`][@stdlib/random/array/tools]</span><span class="delimiter">: </span><span class="description">pseudorandom number generator (PRNG) array creation function tools.</span>
- <span class="signature">[`triangular( len, a, b, c[, options] )`][@stdlib/random/array/triangular]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a triangular distribution.</span>
- <span class="signature">[`uniform( len, a, b[, options] )`][@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="signature">[`weibull( len, k, lambda[, options] )`][@stdlib/random/array/weibull]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Weibull distribution.</span>
Expand Down Expand Up @@ -223,6 +224,8 @@ out = random( 10 );

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

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

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

[@stdlib/random/array/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/random/tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ The namespace exports the following:

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

- <span class="signature">[`unaryFactory( prng, idtypes odtypes, policies[, options] )`][@stdlib/random/tools/unary-factory]</span><span class="delimiter">: </span><span class="description">create a function for generating pseudorandom values drawn from a unary PRNG.</span>
- <span class="signature">[`unary( prng, idtypes odtypes, policies[, options] )`][@stdlib/random/tools/unary]</span><span class="delimiter">: </span><span class="description">constructor for creating ndarrays filled with pseudorandom values drawn from a unary PRNG.</span>

</div>

<!-- </toc> -->

</section>
Expand Down Expand Up @@ -100,6 +107,14 @@ console.log( objectKeys( ns ) );

<section class="links">

<!-- <toc-links> -->

[@stdlib/random/tools/unary-factory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/tools/unary-factory

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

<!-- </toc-links> -->

</section>

<!-- /.links -->