Skip to content

Commit fc5e29d

Browse files
committed
docs: update related packages sections
1 parent 826ecf0 commit fc5e29d

File tree

6 files changed

+85
-0
lines changed

6 files changed

+85
-0
lines changed

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,14 @@ var out = cartesianProduct( x1, x2 );
8787

8888
<section class="related">
8989

90+
* * *
91+
92+
## See Also
93+
94+
- <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>
95+
- <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>
96+
- <span class="package-name">[`@stdlib/array/base/cartesian-square`][@stdlib/array/base/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
97+
9098
</section>
9199

92100
<!-- /.related -->
@@ -97,6 +105,16 @@ var out = cartesianProduct( x1, x2 );
97105

98106
[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
99107

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

102120
<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/two-pi/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ Macro for The mathematical constant [π][@stdlib/constants/float32/pi] times 2.
108108

109109
<section class="related">
110110

111+
* * *
112+
113+
## See Also
114+
115+
- <span class="package-name">[`@stdlib/constants/float32/fourth-pi`][@stdlib/constants/float32/fourth-pi]</span><span class="delimiter">: </span><span class="description">1/4 times π.</span>
116+
- <span class="package-name">[`@stdlib/constants/float32/half-pi`][@stdlib/constants/float32/half-pi]</span><span class="delimiter">: </span><span class="description">1/2 times π.</span>
117+
- <span class="package-name">[`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">π.</span>
118+
111119
</section>
112120

113121
<!-- /.related -->
@@ -118,6 +126,14 @@ Macro for The mathematical constant [π][@stdlib/constants/float32/pi] times 2.
118126

119127
[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi
120128

129+
<!-- <related-links> -->
130+
131+
[@stdlib/constants/float32/fourth-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/fourth-pi
132+
133+
[@stdlib/constants/float32/half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-pi
134+
135+
<!-- </related-links> -->
136+
121137
</section>
122138

123139
<!-- /.links -->

lib/node_modules/@stdlib/math/base/special/acotf/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,14 @@ int main( void ) {
157157

158158
<section class="related">
159159

160+
* * *
161+
162+
## See Also
163+
164+
- <span class="package-name">[`@stdlib/math/base/special/acot`][@stdlib/math/base/special/acot]</span><span class="delimiter">: </span><span class="description">compute the inverse cotangent.</span>
165+
- <span class="package-name">[`@stdlib/math/base/special/acoth`][@stdlib/math/base/special/acoth]</span><span class="delimiter">: </span><span class="description">compute the inverse hyperbolic cotangent.</span>
166+
- <span class="package-name">[`@stdlib/math/base/special/atanf`][@stdlib/math/base/special/atanf]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a single-precision floating-point number.</span>
167+
160168
</section>
161169

162170
<!-- /.related -->
@@ -167,6 +175,16 @@ int main( void ) {
167175

168176
[arccotangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
169177

178+
<!-- <related-links> -->
179+
180+
[@stdlib/math/base/special/acot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acot
181+
182+
[@stdlib/math/base/special/acoth]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acoth
183+
184+
[@stdlib/math/base/special/atanf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanf
185+
186+
<!-- </related-links> -->
187+
170188
</section>
171189

172190
<!-- /.links -->

lib/node_modules/@stdlib/math/strided/special/besselj0-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/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>
237+
- <span class="package-name">[`@stdlib/math/strided/special/bessely0-by`][@stdlib/math/strided/special/bessely0-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the second kind of order zero 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/besselj0]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/besselj0
245253

254+
<!-- <related-links> -->
255+
256+
[@stdlib/math/strided/special/besselj1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj1-by
257+
258+
[@stdlib/math/strided/special/bessely0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely0-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/math/strided/special/dcbrt-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,12 @@ console.log( out );
239239

240240
<section class="related">
241241

242+
* * *
243+
244+
## See Also
245+
246+
- <span class="package-name">[`@stdlib/math/strided/special/cbrt`][@stdlib/math/strided/special/cbrt]</span><span class="delimiter">: </span><span class="description">compute the cube root of each element in a strided array.</span>
247+
242248
</section>
243249

244250
<!-- /.related -->
@@ -251,6 +257,12 @@ console.log( out );
251257

252258
[@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt
253259

260+
<!-- <related-links> -->
261+
262+
[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/cbrt
263+
264+
<!-- </related-links> -->
265+
254266
</section>
255267

256268
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/to-array/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ for ( i = 0; i < 20; i++ ) {
144144

145145
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
146146
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
147+
- <span class="package-name">[`@stdlib/ndarray/to-json`][@stdlib/ndarray/to-json]</span><span class="delimiter">: </span><span class="description">serialize an ndarray as a JSON object.</span>
147148

148149
</section>
149150

@@ -159,6 +160,8 @@ for ( i = 0; i < 20; i++ ) {
159160

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

163+
[@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json
164+
162165
<!-- </related-links> -->
163166

164167
</section>

0 commit comments

Comments
 (0)