Skip to content

Commit 97992ab

Browse files
authored
docs: update related packages sections
PR-URL: #1301 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 5284362 commit 97992ab

File tree

6 files changed

+44
-5
lines changed

6 files changed

+44
-5
lines changed

lib/node_modules/@stdlib/blas/base/gnrm2/README.md

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

188188
<!-- <related-links> -->
189189

190-
191-
192190
<!-- </related-links> -->
193191

194192
</section>

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ logEach( '%f', x4 );
357357
## See Also
358358

359359
- <span class="package-name">[`@stdlib/random/base/t`][@stdlib/random/base/t]</span><span class="delimiter">: </span><span class="description">Student's t-distributed pseudorandom numbers.</span>
360+
- <span class="package-name">[`@stdlib/random/strided/t`][@stdlib/random/strided/t]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Student's t distribution.</span>
360361

361362
</section>
362363

@@ -374,6 +375,12 @@ logEach( '%f', x4 );
374375

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

378+
<!-- <related-links> -->
379+
380+
[@stdlib/random/strided/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/t
381+
382+
<!-- </related-links> -->
383+
377384
</section>
378385

379386
<!-- /.links -->

lib/node_modules/@stdlib/random/base/pareto-type1/README.md

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

409409
<section class="related">
410410

411+
* * *
412+
413+
## See Also
414+
415+
- <span class="package-name">[`@stdlib/random/array/pareto-type1`][@stdlib/random/array/pareto-type1]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Pareto (Type I) distribution.</span>
416+
- <span class="package-name">[`@stdlib/random/iter/pareto-type1`][@stdlib/random/iter/pareto-type1]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Pareto (Type I) distribution.</span>
417+
- <span class="package-name">[`@stdlib/random/streams/pareto-type1`][@stdlib/random/streams/pareto-type1]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Pareto (Type I) distribution.</span>
418+
411419
</section>
412420

413421
<!-- /.related -->
@@ -420,6 +428,16 @@ for ( i = 0; i < 100; i++ ) {
420428

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

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

425443
<!-- /.links -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
212212
## See Also
213213

214214
- <span class="package-name">[`@stdlib/random/base/cosine`][@stdlib/random/base/cosine]</span><span class="delimiter">: </span><span class="description">raised cosine distributed pseudorandom numbers.</span>
215-
- <span class="package-name">[`@stdlib/random/array/cosine`][@stdlib/random/array/cosine]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a cosine distribution.</span>
215+
- <span class="package-name">[`@stdlib/random/array/cosine`][@stdlib/random/array/cosine]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a raised cosine distribution.</span>
216216

217217
</section>
218218

lib/node_modules/@stdlib/string/base/for-each-code-point/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,14 @@ forEachCodePoint( '\uD834\uDD1E', log );
133133

134134
<section class="related">
135135

136+
* * *
137+
138+
## See Also
139+
140+
- <span class="package-name">[`@stdlib/string/base/for-each`][@stdlib/string/base/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each UTF-16 code unit in a string.</span>
141+
- <span class="package-name">[`@stdlib/string/base/for-each-grapheme-cluster`][@stdlib/string/base/for-each-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">invoke a function for each grapheme cluster (i.e., user-perceived character) in a string.</span>
142+
- <span class="package-name">[`@stdlib/string/for-each`][@stdlib/string/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each character in a string.</span>
143+
136144
</section>
137145

138146
<!-- /.related -->
@@ -141,6 +149,16 @@ forEachCodePoint( '\uD834\uDD1E', log );
141149

142150
<section class="links">
143151

152+
<!-- <related-links> -->
153+
154+
[@stdlib/string/base/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each
155+
156+
[@stdlib/string/base/for-each-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-grapheme-cluster
157+
158+
[@stdlib/string/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/for-each
159+
160+
<!-- </related-links> -->
161+
144162
</section>
145163

146164
<!-- /.links -->

lib/node_modules/@stdlib/utils/async/if-then/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,6 @@ next();
237237

238238
<!-- <related-links> -->
239239

240-
[@stdlib/utils/async/if-else]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/if-else
241-
242240
[@stdlib/utils/if-then]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/if-then
243241

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

0 commit comments

Comments
 (0)