Skip to content

Commit 008cf16

Browse files
authored
docs: update related packages sections
PR-URL: #12223 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent b2bd6d6 commit 008cf16

8 files changed

Lines changed: 97 additions & 3 deletions

File tree

lib/node_modules/@stdlib/datasets/us-states-names-capitals/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,6 @@ The data files (databases) are licensed under an [Open Data Commons Public Domai
215215

216216
- <span class="package-name">[`@stdlib/datasets/us-states-capitals`][@stdlib/datasets/us-states-capitals]</span><span class="delimiter">: </span><span class="description">A list of US state capitals in alphabetical order according to state name.</span>
217217
- <span class="package-name">[`@stdlib/datasets/us-states-names`][@stdlib/datasets/us-states-names]</span><span class="delimiter">: </span><span class="description">A list of US state names in alphabetical order.</span>
218-
- <span class="package-name">[`@stdlib/datasets/us-states-names-capitals`][@stdlib/datasets/us-states-names-capitals]</span><span class="delimiter">: </span><span class="description">US state names and capitals.</span>
219218

220219
</section>
221220

@@ -239,8 +238,6 @@ The data files (databases) are licensed under an [Open Data Commons Public Domai
239238

240239
[@stdlib/datasets/us-states-names]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/us-states-names
241240

242-
[@stdlib/datasets/us-states-names-capitals]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/us-states-names-capitals
243-
244241
<!-- </related-links> -->
245242

246243
</section>

lib/node_modules/@stdlib/ndarray/trues/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,15 @@ for ( i = 0; i < dt.length; i++ ) {
157157

158158
<section class="related">
159159

160+
* * *
161+
162+
## See Also
163+
164+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
165+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
166+
- <span class="package-name">[`@stdlib/ndarray/falses`][@stdlib/ndarray/falses]</span><span class="delimiter">: </span><span class="description">create an ndarray filled with false values and having a specified shape and data type.</span>
167+
- <span class="package-name">[`@stdlib/ndarray/trues-like`][@stdlib/ndarray/trues-like]</span><span class="delimiter">: </span><span class="description">create an ndarray filled with true values and having the same shape and data type as a provided ndarray.</span>
168+
160169
</section>
161170

162171
<!-- /.related -->
@@ -169,6 +178,16 @@ for ( i = 0; i < dt.length; i++ ) {
169178

170179
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
171180

181+
<!-- <related-links> -->
182+
183+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
184+
185+
[@stdlib/ndarray/falses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/falses
186+
187+
[@stdlib/ndarray/trues-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/trues-like
188+
189+
<!-- </related-links> -->
190+
172191
</section>
173192

174193
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/vector/uint16/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,24 @@ console.log( v.get() );
179179

180180
<section class="related">
181181

182+
* * *
183+
184+
## See Also
185+
186+
- <span class="package-name">[`@stdlib/ndarray/vector/float64`][@stdlib/ndarray/vector/float64]</span><span class="delimiter">: </span><span class="description">create a double-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
187+
- <span class="package-name">[`@stdlib/ndarray/vector/float32`][@stdlib/ndarray/vector/float32]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
188+
- <span class="package-name">[`@stdlib/ndarray/vector/int16`][@stdlib/ndarray/vector/int16]</span><span class="delimiter">: </span><span class="description">create a signed 16-bit integer vector (i.e., a one-dimensional ndarray).</span>
189+
- <span class="package-name">[`@stdlib/ndarray/vector/int32`][@stdlib/ndarray/vector/int32]</span><span class="delimiter">: </span><span class="description">create a signed 32-bit integer vector (i.e., a one-dimensional ndarray).</span>
190+
- <span class="package-name">[`@stdlib/ndarray/vector/int8`][@stdlib/ndarray/vector/int8]</span><span class="delimiter">: </span><span class="description">create a signed 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
191+
- <span class="package-name">[`@stdlib/ndarray/vector/uint8`][@stdlib/ndarray/vector/uint8]</span><span class="delimiter">: </span><span class="description">create an unsigned 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
192+
- <span class="package-name">[`@stdlib/ndarray/vector/uint32`][@stdlib/ndarray/vector/uint32]</span><span class="delimiter">: </span><span class="description">create an unsigned 32-bit integer vector (i.e., a one-dimensional ndarray).</span>
193+
- <span class="package-name">[`@stdlib/ndarray/vector/uint8c`][@stdlib/ndarray/vector/uint8c]</span><span class="delimiter">: </span><span class="description">create a clamped unsigned 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
194+
- <span class="package-name">[`@stdlib/ndarray/vector/complex128`][@stdlib/ndarray/vector/complex128]</span><span class="delimiter">: </span><span class="description">create a double-precision complex floating-point vector (i.e., a one-dimensional ndarray).</span>
195+
- <span class="package-name">[`@stdlib/ndarray/vector/complex64`][@stdlib/ndarray/vector/complex64]</span><span class="delimiter">: </span><span class="description">create a single-precision complex floating-point vector (i.e., a one-dimensional ndarray).</span>
196+
- <span class="package-name">[`@stdlib/ndarray/vector/bool`][@stdlib/ndarray/vector/bool]</span><span class="delimiter">: </span><span class="description">create a boolean vector (i.e., a one-dimensional ndarray).</span>
197+
- <span class="package-name">[`@stdlib/ndarray/vector/ctor`][@stdlib/ndarray/vector/ctor]</span><span class="delimiter">: </span><span class="description">create a vector (i.e., a one-dimensional ndarray).</span>
198+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
199+
182200
</section>
183201

184202
<!-- /.related -->
@@ -191,6 +209,34 @@ console.log( v.get() );
191209

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

212+
<!-- <related-links> -->
213+
214+
[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float64
215+
216+
[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32
217+
218+
[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int16
219+
220+
[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int32
221+
222+
[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int8
223+
224+
[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint8
225+
226+
[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint32
227+
228+
[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint8c
229+
230+
[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128
231+
232+
[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex64
233+
234+
[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/bool
235+
236+
[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/ctor
237+
238+
<!-- </related-links> -->
239+
194240
</section>
195241

196242
<!-- /.links -->

lib/node_modules/@stdlib/random/array/f/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,7 @@ logEach( '%f', x4 );
358358

359359
## See Also
360360

361+
- <span class="package-name">[`@stdlib/random/f`][@stdlib/random/f]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from an F distribution.</span>
361362
- <span class="package-name">[`@stdlib/random/base/f`][@stdlib/random/base/f]</span><span class="delimiter">: </span><span class="description">F distributed pseudorandom numbers.</span>
362363

363364
</section>
@@ -376,6 +377,12 @@ logEach( '%f', x4 );
376377

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

380+
<!-- <related-links> -->
381+
382+
[@stdlib/random/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/f
383+
384+
<!-- </related-links> -->
385+
379386
</section>
380387

381388
<!-- /.links -->

lib/node_modules/@stdlib/random/array/normal/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,7 @@ logEach( '%f', x4 );
358358

359359
## See Also
360360

361+
- <span class="package-name">[`@stdlib/random/normal`][@stdlib/random/normal]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a normal distribution.</span>
361362
- <span class="package-name">[`@stdlib/random/base/normal`][@stdlib/random/base/normal]</span><span class="delimiter">: </span><span class="description">normally distributed pseudorandom numbers.</span>
362363
- <span class="package-name">[`@stdlib/random/strided/normal`][@stdlib/random/strided/normal]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a normal distribution.</span>
363364

@@ -379,6 +380,8 @@ logEach( '%f', x4 );
379380

380381
<!-- <related-links> -->
381382

383+
[@stdlib/random/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/normal
384+
382385
[@stdlib/random/strided/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/normal
383386

384387
<!-- </related-links> -->

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@ for ( i = 0; i < 100; i++ ) {
416416
- <span class="package-name">[`@stdlib/random/array/betaprime`][@stdlib/random/array/betaprime]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a beta prime distribution.</span>
417417
- <span class="package-name">[`@stdlib/random/iter/betaprime`][@stdlib/random/iter/betaprime]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a beta prime distribution.</span>
418418
- <span class="package-name">[`@stdlib/random/streams/betaprime`][@stdlib/random/streams/betaprime]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a beta prime distribution.</span>
419+
- <span class="package-name">[`@stdlib/random/betaprime`][@stdlib/random/betaprime]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a betaprime distribution.</span>
419420

420421
</section>
421422

@@ -437,6 +438,8 @@ for ( i = 0; i < 100; i++ ) {
437438

438439
[@stdlib/random/streams/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/betaprime
439440

441+
[@stdlib/random/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/betaprime
442+
440443
<!-- </related-links> -->
441444

442445
</section>

lib/node_modules/@stdlib/random/strided/bernoulli/README.md

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

361361
## See Also
362362

363+
- <span class="package-name">[`@stdlib/random/bernoulli`][@stdlib/random/bernoulli]</span><span class="delimiter">: </span><span class="description">generate pseudorandom numbers drawn from a Bernoulli distribution.</span>
363364
- <span class="package-name">[`@stdlib/random/base/bernoulli`][@stdlib/random/base/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distributed pseudorandom numbers.</span>
364365
- <span class="package-name">[`@stdlib/random/array/bernoulli`][@stdlib/random/array/bernoulli]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Bernoulli distribution.</span>
365366

@@ -379,6 +380,8 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
379380

380381
<!-- <related-links> -->
381382

383+
[@stdlib/random/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/bernoulli
384+
382385
[@stdlib/random/array/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/bernoulli
383386

384387
<!-- </related-links> -->

lib/node_modules/@stdlib/random/t/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
358358

359359
<section class="related">
360360

361+
* * *
362+
363+
## See Also
364+
365+
- <span class="package-name">[`@stdlib/random/base/t`][@stdlib/random/base/t]</span><span class="delimiter">: </span><span class="description">Student's t-distributed pseudorandom numbers.</span>
366+
- <span class="package-name">[`@stdlib/random/array/t`][@stdlib/random/array/t]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Student's t-distribution.</span>
367+
- <span class="package-name">[`@stdlib/random/strided/t`][@stdlib/random/strided/t]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Student's t distribution.</span>
368+
361369
</section>
362370

363371
<!-- /.related -->
@@ -378,6 +386,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
378386

379387
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
380388

389+
<!-- <related-links> -->
390+
391+
[@stdlib/random/array/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/t
392+
393+
[@stdlib/random/strided/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/t
394+
395+
<!-- </related-links> -->
396+
381397
</section>
382398

383399
<!-- /.links -->

0 commit comments

Comments
 (0)