Skip to content

Commit f317033

Browse files
authored
docs: update related packages sections
PR-URL: #4040 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 0b0609e commit f317033

File tree

5 files changed

+68
-2
lines changed

5 files changed

+68
-2
lines changed

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

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

8383
<section class="related">
8484

85+
* * *
86+
87+
## See Also
88+
89+
- <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>
90+
- <span class="package-name">[`@stdlib/array/base/cartesian-power`][@stdlib/array/base/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
91+
- <span class="package-name">[`@stdlib/array/base/cartesian-product`][@stdlib/array/base/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
92+
8593
</section>
8694

8795
<!-- /.related -->
@@ -92,6 +100,16 @@ var out = cartesianSquare( x );
92100

93101
[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
94102

103+
<!-- <related-links> -->
104+
105+
[@stdlib/array/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-square
106+
107+
[@stdlib/array/base/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-power
108+
109+
[@stdlib/array/base/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-product
110+
111+
<!-- </related-links> -->
112+
95113
</section>
96114

97115
<!-- /.links -->

lib/node_modules/@stdlib/math/iter/sequences/tribonacci/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,10 @@ while ( true ) {
204204

205205
[@stdlib/math/base/special/tribonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/tribonacci
206206

207-
[@stdlib/math/iter/sequences/lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/iter/sequences/lucas
208-
209207
[@stdlib/math/base/special/fibonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/fibonacci
210208

209+
[@stdlib/math/iter/sequences/lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/iter/sequences/lucas
210+
211211
<!-- </related-links> -->
212212

213213
</section>

lib/node_modules/@stdlib/math/strided/special/bessely0-by/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,14 @@ console.log( y );
229229

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <span class="package-name">[`@stdlib/math/strided/special/besselj0-by`][@stdlib/math/strided/special/besselj0-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the first kind of order zero for each element retrieved from an input strided array via a callback function.</span>
237+
- <span class="package-name">[`@stdlib/math/strided/special/besselj1-by`][@stdlib/math/strided/special/besselj1-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the first kind of order one for each element retrieved from an input strided array via a callback function.</span>
238+
- <span class="package-name">[`@stdlib/math/strided/special/bessely1-by`][@stdlib/math/strided/special/bessely1-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the second kind of order one for each element retrieved from an input strided array via a callback function.</span>
239+
232240
</section>
233241

234242
<!-- /.related -->
@@ -243,6 +251,16 @@ console.log( y );
243251

244252
[@stdlib/math/base/special/bessely0]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/bessely0
245253

254+
<!-- <related-links> -->
255+
256+
[@stdlib/math/strided/special/besselj0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj0-by
257+
258+
[@stdlib/math/strided/special/besselj1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj1-by
259+
260+
[@stdlib/math/strided/special/bessely1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely1-by
261+
262+
<!-- </related-links> -->
263+
246264
</section>
247265

248266
<!-- /.links -->

lib/node_modules/@stdlib/string/base/right-trim/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ out = rtrim( '\n\n\nNew Lines\n\n\n' );
9696

9797
<section class="related">
9898

99+
* * *
100+
101+
## See Also
102+
103+
- <span class="package-name">[`@stdlib/string/base/left-trim`][@stdlib/string/base/left-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning of a string.</span>
104+
99105
</section>
100106

101107
<!-- /.related -->
@@ -106,6 +112,12 @@ out = rtrim( '\n\n\nNew Lines\n\n\n' );
106112

107113
[unicode]: https://en.wikipedia.org/wiki/Unicode
108114

115+
<!-- <related-links> -->
116+
117+
[@stdlib/string/base/left-trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/left-trim
118+
119+
<!-- </related-links> -->
120+
109121
</section>
110122

111123
<!-- /.links -->

lib/node_modules/@stdlib/string/base/startcase/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ str = startcase( '' );
8282

8383
<section class="related">
8484

85+
* * *
86+
87+
## See Also
88+
89+
- <span class="package-name">[`@stdlib/string/base/capitalize`][@stdlib/string/base/capitalize]</span><span class="delimiter">: </span><span class="description">capitalize the first character in a string.</span>
90+
- <span class="package-name">[`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
91+
- <span class="package-name">[`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
92+
8593
</section>
8694

8795
<!-- /.related -->
@@ -90,6 +98,16 @@ str = startcase( '' );
9098

9199
<section class="links">
92100

101+
<!-- <related-links> -->
102+
103+
[@stdlib/string/base/capitalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/capitalize
104+
105+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
106+
107+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
108+
109+
<!-- </related-links> -->
110+
93111
</section>
94112

95113
<!-- /.links -->

0 commit comments

Comments
 (0)