Skip to content

Commit d675ecd

Browse files
authored
docs: update related packages sections (#1309)
1 parent 6008b22 commit d675ecd

File tree

5 files changed

+67
-1
lines changed

5 files changed

+67
-1
lines changed

lib/node_modules/@stdlib/array/cartesian-power/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ var out = cartesianPower( x, 3 );
8989

9090
<section class="related">
9191

92+
* * *
93+
94+
## See Also
95+
96+
- <span class="package-name">[`@stdlib/array/cartesian-product`][@stdlib/array/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
97+
- <span class="package-name">[`@stdlib/array/cartesian-square`][@stdlib/array/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
98+
9299
</section>
93100

94101
<!-- /.related -->
@@ -99,6 +106,14 @@ var out = cartesianPower( x, 3 );
99106

100107
[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
101108

109+
<!-- <related-links> -->
110+
111+
[@stdlib/array/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-product
112+
113+
[@stdlib/array/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-square
114+
115+
<!-- </related-links> -->
116+
102117
</section>
103118

104119
<!-- /.links -->

lib/node_modules/@stdlib/array/cartesian-square/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,13 @@ var out = cartesianSquare( x );
8282

8383
<section class="related">
8484

85+
* * *
86+
87+
## See Also
88+
89+
- <span class="package-name">[`@stdlib/array/cartesian-power`][@stdlib/array/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
90+
- <span class="package-name">[`@stdlib/array/cartesian-product`][@stdlib/array/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
91+
8592
</section>
8693

8794
<!-- /.related -->
@@ -92,6 +99,14 @@ var out = cartesianSquare( x );
9299

93100
[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
94101

102+
<!-- <related-links> -->
103+
104+
[@stdlib/array/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-power
105+
106+
[@stdlib/array/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-product
107+
108+
<!-- </related-links> -->
109+
95110
</section>
96111

97112
<!-- /.links -->

lib/node_modules/@stdlib/array/typed-complex-dtypes/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ bool = isdtype( 'beep' );
117117

118118
- <span class="package-name">[`@stdlib/array/dtypes`][@stdlib/array/dtypes]</span><span class="delimiter">: </span><span class="description">list of array data types.</span>
119119
- <span class="package-name">[`@stdlib/array/typed-dtypes`][@stdlib/array/typed-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
120-
- <span class="package-name">[`@stdlib/array/typed-real-dtypes`][@stdlib/array/typed-real-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span>
120+
- <span class="package-name">[`@stdlib/array/typed-real-dtypes`][@stdlib/array/typed-real-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array real-valued data types.</span>
121121
- <span class="package-name">[`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
122122

123123
</section>

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

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

406406
<section class="related">
407407

408+
* * *
409+
410+
## See Also
411+
412+
- <span class="package-name">[`@stdlib/random/array/geometric`][@stdlib/random/array/geometric]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a geometric distribution.</span>
413+
- <span class="package-name">[`@stdlib/random/iter/geometric`][@stdlib/random/iter/geometric]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a geometric distribution.</span>
414+
- <span class="package-name">[`@stdlib/random/streams/geometric`][@stdlib/random/streams/geometric]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a geometric distribution.</span>
415+
408416
</section>
409417

410418
<!-- /.related -->
@@ -417,6 +425,16 @@ for ( i = 0; i < 100; i++ ) {
417425

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

428+
<!-- <related-links> -->
429+
430+
[@stdlib/random/array/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/geometric
431+
432+
[@stdlib/random/iter/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/geometric
433+
434+
[@stdlib/random/streams/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/geometric
435+
436+
<!-- </related-links> -->
437+
420438
</section>
421439

422440
<!-- /.links -->

lib/node_modules/@stdlib/random/base/negative-binomial/README.md

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

413413
<section class="related">
414414

415+
* * *
416+
417+
## See Also
418+
419+
- <span class="package-name">[`@stdlib/random/array/negative-binomial`][@stdlib/random/array/negative-binomial]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a negative binomial distribution.</span>
420+
- <span class="package-name">[`@stdlib/random/iter/negative-binomial`][@stdlib/random/iter/negative-binomial]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a negative binomial distribution.</span>
421+
- <span class="package-name">[`@stdlib/random/streams/negative-binomial`][@stdlib/random/streams/negative-binomial]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a negative binomial distribution.</span>
422+
415423
</section>
416424

417425
<!-- /.related -->
@@ -424,6 +432,16 @@ for ( i = 0; i < 100; i++ ) {
424432

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

435+
<!-- <related-links> -->
436+
437+
[@stdlib/random/array/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/negative-binomial
438+
439+
[@stdlib/random/iter/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/iter/negative-binomial
440+
441+
[@stdlib/random/streams/negative-binomial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/negative-binomial
442+
443+
<!-- </related-links> -->
444+
427445
</section>
428446

429447
<!-- /.links -->

0 commit comments

Comments
 (0)