Skip to content

Commit 74bf172

Browse files
authored
docs: update related packages sections
PR-URL: #1165 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 02f2e68 commit 74bf172

File tree

7 files changed

+93
-0
lines changed

7 files changed

+93
-0
lines changed

Diff for: lib/node_modules/@stdlib/assert/is-complex64matrix-like/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,14 @@ out = isComplex64MatrixLike( null );
8383

8484
<section class="related">
8585

86+
* * *
87+
88+
## See Also
89+
90+
- <span class="package-name">[`@stdlib/assert/is-complex128matrix-like`][@stdlib/assert/is-complex128matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object containing double-precision complex floating-point numbers.</span>
91+
- <span class="package-name">[`@stdlib/assert/is-ndarray-like`][@stdlib/assert/is-ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is ndarray-like.</span>
92+
- <span class="package-name">[`@stdlib/assert/is-matrix-like`][@stdlib/assert/is-matrix-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 2-dimensional ndarray-like object.</span>
93+
8694
</section>
8795

8896
<!-- /.related -->
@@ -93,6 +101,16 @@ out = isComplex64MatrixLike( null );
93101

94102
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
95103

104+
<!-- <related-links> -->
105+
106+
[@stdlib/assert/is-complex128matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex128matrix-like
107+
108+
[@stdlib/assert/is-ndarray-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-ndarray-like
109+
110+
[@stdlib/assert/is-matrix-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-matrix-like
111+
112+
<!-- </related-links> -->
113+
96114
</section>
97115

98116
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/math/base/ops/addf/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ int main( void ) {
196196
## See Also
197197

198198
- <span class="package-name">[`@stdlib/math/base/ops/add`][@stdlib/math/base/ops/add]</span><span class="delimiter">: </span><span class="description">compute the sum of two double-precision floating-point numbers.</span>
199+
- <span class="package-name">[`@stdlib/math/base/ops/divf`][@stdlib/math/base/ops/divf]</span><span class="delimiter">: </span><span class="description">divide two single-precision floating-point numbers.</span>
199200
- <span class="package-name">[`@stdlib/math/base/ops/mulf`][@stdlib/math/base/ops/mulf]</span><span class="delimiter">: </span><span class="description">multiply two single-precision floating-point numbers.</span>
200201
- <span class="package-name">[`@stdlib/math/base/ops/subf`][@stdlib/math/base/ops/subf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>
201202

@@ -211,6 +212,8 @@ int main( void ) {
211212

212213
[@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add
213214

215+
[@stdlib/math/base/ops/divf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/divf
216+
214217
[@stdlib/math/base/ops/mulf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mulf
215218

216219
[@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf

Diff for: lib/node_modules/@stdlib/math/base/ops/div/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,14 @@ int main( void ) {
191191

192192
<section class="related">
193193

194+
* * *
195+
196+
## See Also
197+
198+
- <span class="package-name">[`@stdlib/math/base/ops/add`][@stdlib/math/base/ops/add]</span><span class="delimiter">: </span><span class="description">compute the sum of two double-precision floating-point numbers.</span>
199+
- <span class="package-name">[`@stdlib/math/base/ops/mul`][@stdlib/math/base/ops/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision floating-point numbers.</span>
200+
- <span class="package-name">[`@stdlib/math/base/ops/sub`][@stdlib/math/base/ops/sub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision floating-point numbers.</span>
201+
194202
</section>
195203

196204
<!-- /.related -->
@@ -199,6 +207,16 @@ int main( void ) {
199207

200208
<section class="links">
201209

210+
<!-- <related-links> -->
211+
212+
[@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add
213+
214+
[@stdlib/math/base/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul
215+
216+
[@stdlib/math/base/ops/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/sub
217+
218+
<!-- </related-links> -->
219+
202220
</section>
203221

204222
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/random/array/discrete-uniform/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,14 @@ logEach( '%d', x4 );
331331

332332
<section class="related">
333333

334+
* * *
335+
336+
## See Also
337+
338+
- <span class="package-name">[`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
339+
- <span class="package-name">[`@stdlib/random/base/discrete-uniform`][@stdlib/random/base/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distributed pseudorandom numbers.</span>
340+
- <span class="package-name">[`@stdlib/random/strided/discrete-uniform`][@stdlib/random/strided/discrete-uniform]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a discrete uniform distribution.</span>
341+
334342
</section>
335343

336344
<!-- /.related -->
@@ -347,6 +355,16 @@ logEach( '%d', x4 );
347355

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

358+
<!-- <related-links> -->
359+
360+
[@stdlib/random/array/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform
361+
362+
[@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/discrete-uniform
363+
364+
[@stdlib/random/strided/discrete-uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/discrete-uniform
365+
366+
<!-- </related-links> -->
367+
350368
</section>
351369

352370
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/random/strided/arcsine/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
207207

208208
<section class="related">
209209

210+
* * *
211+
212+
## See Also
213+
214+
- <span class="package-name">[`@stdlib/random/base/arcsine`][@stdlib/random/base/arcsine]</span><span class="delimiter">: </span><span class="description">arcsine distributed pseudorandom numbers.</span>
215+
- <span class="package-name">[`@stdlib/random/array/arcsine`][@stdlib/random/array/arcsine]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an arcsine distribution.</span>
216+
210217
</section>
211218

212219
<!-- /.related -->
@@ -221,6 +228,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
221228

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

231+
<!-- <related-links> -->
232+
233+
[@stdlib/random/array/arcsine]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/arcsine
234+
235+
<!-- </related-links> -->
236+
224237
</section>
225238

226239
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/slice/seq2slice/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,8 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
270270

271271
<!-- <related-links> -->
272272

273+
274+
273275
<!-- </related-links> -->
274276

275277
</section>

Diff for: lib/node_modules/@stdlib/string/dotcase/README.md

+21
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 -->

0 commit comments

Comments
 (0)