Skip to content

Commit afa953b

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#1281 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 9bf0264 commit afa953b

9 files changed

Lines changed: 115 additions & 2 deletions

File tree

‎lib/node_modules/@stdlib/assert/is-same-complex64array/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ out = isSameComplex64Array( x, y );
9494

9595
<section class="related">
9696

97+
* * *
98+
99+
## See Also
100+
101+
- <span class="package-name">[`@stdlib/assert/is-complex64array`][@stdlib/assert/is-complex64array]</span><span class="delimiter">: </span><span class="description">test if a value is a Complex64Array.</span>
102+
- <span class="package-name">[`@stdlib/assert/is-same-complex128array`][@stdlib/assert/is-same-complex128array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex128Arrays and have the same values.</span>
103+
- <span class="package-name">[`@stdlib/assert/is-same-float32array`][@stdlib/assert/is-same-float32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float32Arrays and have the same values.</span>
104+
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
105+
97106
</section>
98107

99108
<!-- /.related -->
@@ -106,6 +115,16 @@ out = isSameComplex64Array( x, y );
106115

107116
[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-value
108117

118+
<!-- <related-links> -->
119+
120+
[@stdlib/assert/is-complex64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex64array
121+
122+
[@stdlib/assert/is-same-complex128array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-complex128array
123+
124+
[@stdlib/assert/is-same-float32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-float32array
125+
126+
<!-- </related-links> -->
127+
109128
</section>
110129

111130
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-same-float64array/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,13 @@ out = isSameFloat64Array( x, y );
9494

9595
<section class="related">
9696

97+
* * *
98+
99+
## See Also
100+
101+
- <span class="package-name">[`@stdlib/assert/is-same-float32array`][@stdlib/assert/is-same-float32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float32Arrays and have the same values.</span>
102+
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
103+
97104
</section>
98105

99106
<!-- /.related -->
@@ -106,6 +113,12 @@ out = isSameFloat64Array( x, y );
106113

107114
[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-value
108115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/assert/is-same-float32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-float32array
119+
120+
<!-- </related-links> -->
121+
109122
</section>
110123

111124
<!-- /.links -->

‎lib/node_modules/@stdlib/random/array/hypergeometric/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/hypergeometric`][@stdlib/random/base/hypergeometric]</span><span class="delimiter">: </span><span class="description">hypergeometric distributed pseudorandom numbers.</span>
364+
359365
</section>
360366

361367
<!-- /.related -->

‎lib/node_modules/@stdlib/random/base/cosine/README.md‎

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

402402
<section class="related">
403403

404+
* * *
405+
406+
## See Also
407+
408+
- <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>
409+
- <span class="package-name">[`@stdlib/random/iter/cosine`][@stdlib/random/iter/cosine]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a raised cosine distribution.</span>
410+
- <span class="package-name">[`@stdlib/random/streams/cosine`][@stdlib/random/streams/cosine]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a raised cosine distribution.</span>
411+
404412
</section>
405413

406414
<!-- /.related -->
@@ -413,6 +421,16 @@ for ( i = 0; i < 100; i++ ) {
413421

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

424+
<!-- <related-links> -->
425+
426+
[@stdlib/random/array/cosine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/cosine
427+
428+
[@stdlib/random/iter/cosine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/cosine
429+
430+
[@stdlib/random/streams/cosine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/cosine
431+
432+
<!-- </related-links> -->
433+
416434
</section>
417435

418436
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/frechet/README.md‎

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

422422
<section class="related">
423423

424+
* * *
425+
426+
## See Also
427+
428+
- <span class="package-name">[`@stdlib/random/array/frechet`][@stdlib/random/array/frechet]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Fréchet distribution.</span>
429+
- <span class="package-name">[`@stdlib/random/iter/frechet`][@stdlib/random/iter/frechet]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a Fréchet distribution.</span>
430+
- <span class="package-name">[`@stdlib/random/streams/frechet`][@stdlib/random/streams/frechet]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a Fréchet distribution.</span>
431+
424432
</section>
425433

426434
<!-- /.related -->
@@ -433,6 +441,16 @@ for ( i = 0; i < 100; i++ ) {
433441

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

444+
<!-- <related-links> -->
445+
446+
[@stdlib/random/array/frechet]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/frechet
447+
448+
[@stdlib/random/iter/frechet]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/frechet
449+
450+
[@stdlib/random/streams/frechet]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/frechet
451+
452+
<!-- </related-links> -->
453+
436454
</section>
437455

438456
<!-- /.links -->

‎lib/node_modules/@stdlib/random/base/hypergeometric/README.md‎

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

424424
<section class="related">
425425

426+
* * *
427+
428+
## See Also
429+
430+
- <span class="package-name">[`@stdlib/random/array/hypergeometric`][@stdlib/random/array/hypergeometric]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a hypergeometric distribution.</span>
431+
- <span class="package-name">[`@stdlib/random/iter/hypergeometric`][@stdlib/random/iter/hypergeometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a hypergeometric distribution.</span>
432+
- <span class="package-name">[`@stdlib/random/streams/hypergeometric`][@stdlib/random/streams/hypergeometric]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a hypergeometric distribution.</span>
433+
426434
</section>
427435

428436
<!-- /.related -->
@@ -437,6 +445,16 @@ for ( i = 0; i < 100; i++ ) {
437445

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

448+
<!-- <related-links> -->
449+
450+
[@stdlib/random/array/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/hypergeometric
451+
452+
[@stdlib/random/iter/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/hypergeometric
453+
454+
[@stdlib/random/streams/hypergeometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/hypergeometric
455+
456+
<!-- </related-links> -->
457+
440458
</section>
441459

442460
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/fligner-test/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ var table = out.print();
190190

191191
## See Also
192192

193-
- <span class="package-name">[`@stdlib/stats/bartlett-test`][@stdlib/stats/bartlett-test]</span><span class="delimiter">: </span><span class="description">bartlett’s test for equal variances.</span>
193+
- <span class="package-name">[`@stdlib/stats/bartlett-test`][@stdlib/stats/bartlett-test]</span><span class="delimiter">: </span><span class="description">Bartlett’s test for equal variances.</span>
194194

195195
</section>
196196

‎lib/node_modules/@stdlib/string/headercase/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,15 @@ Foo-Bar
162162

163163
<section class="related">
164164

165+
* * *
166+
167+
## See Also
168+
169+
- <span class="package-name">[`@stdlib/string/camelcase`][@stdlib/string/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
170+
- <span class="package-name">[`@stdlib/string/kebabcase`][@stdlib/string/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
171+
- <span class="package-name">[`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
172+
- <span class="package-name">[`@stdlib/string/snakecase`][@stdlib/string/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
173+
165174
</section>
166175

167176
<!-- /.related -->
@@ -174,6 +183,18 @@ Foo-Bar
174183

175184
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
176185

186+
<!-- <related-links> -->
187+
188+
[@stdlib/string/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/camelcase
189+
190+
[@stdlib/string/kebabcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/kebabcase
191+
192+
[@stdlib/string/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/pascalcase
193+
194+
[@stdlib/string/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/snakecase
195+
196+
<!-- </related-links> -->
197+
177198
</section>
178199

179200
<!-- /.links -->

‎lib/node_modules/@stdlib/string/remove-first/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ oop
202202

203203
## See Also
204204

205-
- <span class="package-name">[`@stdlib/string/remove-last`][@stdlib/string/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last character of a string.</span>
205+
- <span class="package-name">[`@stdlib/string/remove-last`][@stdlib/string/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last character(s) of a string.</span>
206206

207207
</section>
208208

0 commit comments

Comments
 (0)