Skip to content

Commit 4315e33

Browse files
authored
docs: update related packages sections
PR-URL: stdlib-js#1320 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 5b3b916 commit 4315e33

File tree

4 files changed

+53
-0
lines changed

4 files changed

+53
-0
lines changed

lib/node_modules/@stdlib/math/base/special/ellipj/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,15 @@ for ( i = 0; i < 100; i++ ) {
183183

184184
<section class="related">
185185

186+
* * *
187+
188+
## See Also
189+
190+
- <span class="package-name">[`@stdlib/math/base/special/ellipe`][@stdlib/math/base/special/ellipe]</span><span class="delimiter">: </span><span class="description">compute the complete elliptic integral of the second kind.</span>
191+
- <span class="package-name">[`@stdlib/math/base/special/ellipk`][@stdlib/math/base/special/ellipk]</span><span class="delimiter">: </span><span class="description">compute the complete elliptic integral of the first kind.</span>
192+
193+
</section>
194+
186195
<!-- /.related -->
187196

188197
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -199,6 +208,10 @@ for ( i = 0; i < 100; i++ ) {
199208

200209
<!-- <related-links> -->
201210

211+
[@stdlib/math/base/special/ellipe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipe
212+
213+
[@stdlib/math/base/special/ellipk]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ellipk
214+
202215
<!-- </related-links> -->
203216

204217
</section>

lib/node_modules/@stdlib/random/base/f/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,14 @@ for ( i = 0; i < 100; i++ ) {
409409

410410
<section class="related">
411411

412+
* * *
413+
414+
## See Also
415+
416+
- <span class="package-name">[`@stdlib/random/array/f`][@stdlib/random/array/f]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an F distribution.</span>
417+
- <span class="package-name">[`@stdlib/random/iter/f`][@stdlib/random/iter/f]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from an F distribution.</span>
418+
- <span class="package-name">[`@stdlib/random/streams/f`][@stdlib/random/streams/f]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from an F distribution.</span>
419+
412420
</section>
413421

414422
<!-- /.related -->
@@ -421,6 +429,16 @@ for ( i = 0; i < 100; i++ ) {
421429

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

432+
<!-- <related-links> -->
433+
434+
[@stdlib/random/array/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/f
435+
436+
[@stdlib/random/iter/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/f
437+
438+
[@stdlib/random/streams/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/f
439+
440+
<!-- </related-links> -->
441+
424442
</section>
425443

426444
<!-- /.links -->

lib/node_modules/@stdlib/random/base/randu/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,9 @@ for ( i = 0; i < 100; i++ ) {
312312

313313
## See Also
314314

315+
- <span class="package-name">[`@stdlib/random/array/randu`][@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>
316+
- <span class="package-name">[`@stdlib/random/iter/randu`][@stdlib/random/iter/randu]</span><span class="delimiter">: </span><span class="description">create an iterator for generating uniformly distributed pseudorandom numbers between 0 and 1.</span>
317+
- <span class="package-name">[`@stdlib/random/streams/randu`][@stdlib/random/streams/randu]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating uniformly distributed pseudorandom numbers between 0 and 1.</span>
315318
- <span class="package-name">[`@stdlib/random/base/discrete-uniform`][@stdlib/random/base/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distributed pseudorandom numbers.</span>
316319
- <span class="package-name">[`@stdlib/random/base/randn`][@stdlib/random/base/randn]</span><span class="delimiter">: </span><span class="description">standard normal pseudorandom numbers.</span>
317320

@@ -331,6 +334,12 @@ for ( i = 0; i < 100; i++ ) {
331334

332335
<!-- <related-links> -->
333336

337+
[@stdlib/random/array/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/randu
338+
339+
[@stdlib/random/iter/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/randu
340+
341+
[@stdlib/random/streams/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/randu
342+
334343
[@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/discrete-uniform
335344

336345
[@stdlib/random/base/randn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/randn

lib/node_modules/@stdlib/random/strided/rayleigh/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
356356

357357
<section class="related">
358358

359+
* * *
360+
361+
## See Also
362+
363+
- <span class="package-name">[`@stdlib/random/base/rayleigh`][@stdlib/random/base/rayleigh]</span><span class="delimiter">: </span><span class="description">Rayleigh distributed pseudorandom numbers.</span>
364+
- <span class="package-name">[`@stdlib/random/array/rayleigh`][@stdlib/random/array/rayleigh]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Rayleigh distribution.</span>
365+
359366
</section>
360367

361368
<!-- /.related -->
@@ -370,6 +377,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
370377

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

380+
<!-- <related-links> -->
381+
382+
[@stdlib/random/array/rayleigh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/rayleigh
383+
384+
<!-- </related-links> -->
385+
373386
</section>
374387

375388
<!-- /.links -->

0 commit comments

Comments
 (0)