Skip to content

Commit f04074a

Browse files
authored
docs: update related packages sections
PR-URL: #1276 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 2e71bed commit f04074a

File tree

6 files changed

+38
-4
lines changed

6 files changed

+38
-4
lines changed

lib/node_modules/@stdlib/constants/complex64/nan/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,26 @@ im = imagf( v );
9393

9494
<section class="related">
9595

96+
* * *
97+
98+
## See Also
99+
100+
- <span class="package-name">[`@stdlib/constants/complex128/nan`][@stdlib/constants/complex128/nan]</span><span class="delimiter">: </span><span class="description">canonical double-precision complex floating-point NaN.</span>
101+
102+
</section>
103+
96104
<!-- /.related -->
97105

98106
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
99107

100108
<section class="links">
101109

110+
<!-- <related-links> -->
111+
112+
[@stdlib/constants/complex128/nan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/complex128/nan
113+
114+
<!-- </related-links> -->
115+
102116
</section>
103117

104118
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/dispatch/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,6 @@ console.log( ybuf );
274274

275275
<!-- <related-links> -->
276276

277-
278-
279277
<!-- </related-links> -->
280278

281279
</section>

lib/node_modules/@stdlib/ndarray/numel/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ for ( i = 0; i < slices.length; i++ ) {
136136

137137
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
138138
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
139+
- <span class="package-name">[`@stdlib/ndarray/numel-dimension`][@stdlib/ndarray/numel-dimension]</span><span class="delimiter">: </span><span class="description">return the size (i.e., number of elements) of a specified dimension for a provided ndarray.</span>
139140

140141
</section>
141142

@@ -151,6 +152,8 @@ for ( i = 0; i < slices.length; i++ ) {
151152

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

155+
[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel-dimension
156+
154157
<!-- </related-links> -->
155158

156159
</section>

lib/node_modules/@stdlib/random/array/triangular/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,12 @@ logEach( '%f', x4 );
356356

357357
<section class="related">
358358

359+
* * *
360+
361+
## See Also
362+
363+
- <span class="package-name">[`@stdlib/random/base/triangular`][@stdlib/random/base/triangular]</span><span class="delimiter">: </span><span class="description">triangular distributed pseudorandom numbers.</span>
364+
359365
</section>
360366

361367
<!-- /.related -->

lib/node_modules/@stdlib/random/base/box-muller/README.md

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

423423
<section class="related">
424424

425+
* * *
426+
427+
## See Also
428+
429+
- <span class="package-name">[`@stdlib/random/iter/box-muller`][@stdlib/random/iter/box-muller]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span>
430+
- <span class="package-name">[`@stdlib/random/streams/box-muller`][@stdlib/random/streams/box-muller]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span>
431+
425432
</section>
426433

427434
<!-- /.related -->
@@ -444,6 +451,14 @@ for ( i = 0; i < 100; i++ ) {
444451

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

454+
<!-- <related-links> -->
455+
456+
[@stdlib/random/iter/box-muller]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/box-muller
457+
458+
[@stdlib/random/streams/box-muller]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/box-muller
459+
460+
<!-- </related-links> -->
461+
447462
</section>
448463

449464
<!-- /.links -->

lib/node_modules/@stdlib/slice/multi/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,6 @@ console.log( JSON.stringify( o ) );
251251

252252
<!-- <related-links> -->
253253

254-
255-
256254
<!-- </related-links> -->
257255

258256
</section>

0 commit comments

Comments
 (0)