Skip to content

Commit 26cf434

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#1156 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 5083aff commit 26cf434

File tree

10 files changed

+74
-4
lines changed

10 files changed

+74
-4
lines changed

‎lib/node_modules/@stdlib/assert/is-complex64vector-like/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,14 @@ out = isComplex64VectorLike( null );
8383

8484
<section class="related">
8585

86+
* * *
87+
88+
## See Also
89+
90+
- <span class="package-name">[`@stdlib/assert/is-complex128vector-like`][@stdlib/assert/is-complex128vector-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 1-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-vector-like`][@stdlib/assert/is-vector-like]</span><span class="delimiter">: </span><span class="description">test if a value is a 1-dimensional ndarray-like object.</span>
93+
8694
</section>
8795

8896
<!-- /.related -->
@@ -93,6 +101,16 @@ out = isComplex64VectorLike( 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-complex128vector-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-complex128vector-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-vector-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-vector-like
111+
112+
<!-- </related-links> -->
113+
96114
</section>
97115

98116
<!-- /.links -->

‎lib/node_modules/@stdlib/fs/read-wasm/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ function onRead( error, wasm ) {
151151

152152
<!-- <related-links> -->
153153

154-
[@stdlib/fs/read-file]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/fs/read-file
154+
155155

156156
<!-- </related-links> -->
157157

‎lib/node_modules/@stdlib/math/iter/special/riemann-zeta/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ while ( true ) {
149149

150150
<!-- <related-links> -->
151151

152+
153+
152154
<!-- </related-links> -->
153155

154156
</section>

‎lib/node_modules/@stdlib/ndarray/fancy/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -797,8 +797,6 @@ console.log( toArray( y4 ) );
797797

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

800-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
801-
802800
<!-- </related-links> -->
803801

804802
</section>

‎lib/node_modules/@stdlib/ndarray/slice-dimension-from/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ var a3 = ndarray2array( y3 );
196196
- <span class="package-name">[`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray.</span>
197197
- <span class="package-name">[`@stdlib/ndarray/slice-dimension`][@stdlib/ndarray/slice-dimension]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray when sliced along a specified dimension.</span>
198198
- <span class="package-name">[`@stdlib/ndarray/slice-dimension-to`][@stdlib/ndarray/slice-dimension-to]</span><span class="delimiter">: </span><span class="description">return a read-only truncated view of an input ndarray along a specific dimension.</span>
199+
- <span class="package-name">[`@stdlib/ndarray/slice-from`][@stdlib/ndarray/slice-from]</span><span class="delimiter">: </span><span class="description">return a read-only shifted view of an input ndarray.</span>
199200

200201
</section>
201202

@@ -217,6 +218,8 @@ var a3 = ndarray2array( y3 );
217218

218219
[@stdlib/ndarray/slice-dimension-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-dimension-to
219220

221+
[@stdlib/ndarray/slice-from]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice-from
222+
220223
<!-- </related-links> -->
221224

222225
</section>

‎lib/node_modules/@stdlib/number/uint32/base/from-binary-string/README.md‎

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

9292
<section class="related">
9393

94+
* * *
95+
96+
## See Also
97+
98+
- <span class="package-name">[`@stdlib/number/uint16/base/from-binary-string`][@stdlib/number/uint16/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 16-bit integer from a literal bit representation.</span>
99+
- <span class="package-name">[`@stdlib/number/uint32/base/to-binary-string`][@stdlib/number/uint32/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of an unsigned 32-bit integer.</span>
100+
- <span class="package-name">[`@stdlib/number/uint8/base/from-binary-string`][@stdlib/number/uint8/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 8-bit integer from a literal bit representation.</span>
101+
94102
</section>
95103

96104
<!-- /.related -->
@@ -101,6 +109,14 @@ for ( i = 0; i < 100; i++ ) {
101109

102110
[@stdlib/number/uint32/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/to-binary-string
103111

112+
<!-- <related-links> -->
113+
114+
[@stdlib/number/uint16/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/from-binary-string
115+
116+
[@stdlib/number/uint8/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/from-binary-string
117+
118+
<!-- </related-links> -->
119+
104120
</section>
105121

106122
<!-- /.links -->

‎lib/node_modules/@stdlib/random/array/mt19937/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,14 @@ logEach( '%f', x4 );
268268

269269
<section class="related">
270270

271+
* * *
272+
273+
## See Also
274+
275+
- <span class="package-name">[`@stdlib/random/array/randu`][@stdlib/random/array/randu]</span><span class="delimiter">: </span><span class="description">create an array containing uniformly distributed pseudorandom numbers between 0 and 1.</span>
276+
- <span class="package-name">[`@stdlib/random/base/mt19937`][@stdlib/random/base/mt19937]</span><span class="delimiter">: </span><span class="description">A 32-bit Mersenne Twister pseudorandom number generator.</span>
277+
- <span class="package-name">[`@stdlib/random/strided/mt19937`][@stdlib/random/strided/mt19937]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers generated using a 32-bit Mersenne Twister pseudorandom number generator.</span>
278+
271279
</section>
272280

273281
<!-- /.related -->
@@ -286,6 +294,14 @@ logEach( '%f', x4 );
286294

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

297+
<!-- <related-links> -->
298+
299+
[@stdlib/random/array/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/randu
300+
301+
[@stdlib/random/strided/mt19937]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/mt19937
302+
303+
<!-- </related-links> -->
304+
289305
</section>
290306

291307
<!-- /.links -->

‎lib/node_modules/@stdlib/random/strided/randu/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,14 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
204204

205205
<section class="related">
206206

207+
* * *
208+
209+
## See Also
210+
211+
- <span class="package-name">[`@stdlib/random/base/randu`][@stdlib/random/base/randu]</span><span class="delimiter">: </span><span class="description">uniformly distributed pseudorandom numbers between 0 and 1.</span>
212+
- <span class="package-name">[`@stdlib/random/array/randu`][@stdlib/random/array/randu]</span><span class="delimiter">: </span><span class="description">create an array containing uniformly distributed pseudorandom numbers between 0 and 1.</span>
213+
- <span class="package-name">[`@stdlib/random/strided/uniform`][@stdlib/random/strided/uniform]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a continuous uniform distribution.</span>
214+
207215
</section>
208216

209217
<!-- /.related -->
@@ -222,6 +230,14 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
222230

223231
[@stdlib/random/base/minstd-shuffle]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/minstd-shuffle
224232

233+
<!-- <related-links> -->
234+
235+
[@stdlib/random/array/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/randu
236+
237+
[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/uniform
238+
239+
<!-- </related-links> -->
240+
225241
</section>
226242

227243
<!-- /.links -->

‎lib/node_modules/@stdlib/slice/multi/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,8 @@ console.log( JSON.stringify( o ) );
251251

252252
<!-- <related-links> -->
253253

254+
255+
254256
<!-- </related-links> -->
255257

256258
</section>

‎lib/node_modules/@stdlib/string/left-trim-n/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ out = ltrimN( '~~~CUSTOM~~~', 3, '~' );
101101

102102
<!-- /.examples -->
103103

104-
105104
<!-- Section for describing a command-line interface. -->
106105

107106
* * *

0 commit comments

Comments
 (0)