Skip to content

Commit 32deb11

Browse files
authored
docs: update related packages sections
PR-URL: #3976 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent c1930df commit 32deb11

File tree

12 files changed

+88
-8
lines changed

12 files changed

+88
-8
lines changed

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ var out = arr.map( fcn, context );
692692
var count = context.count;
693693
// returns 3;
694694
```
695-
695+
696696
<a name="method-reduce"></a>
697697

698698
#### TypedArray.prototype.reduce( reducerFn\[, initialValue] )
@@ -758,7 +758,7 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
758758
var out = arr.reduceRight( reducer );
759759
// returns 0.0
760760
```
761-
761+
762762
The reducer function is provided four arguments:
763763

764764
- **acc**: accumulated result.
@@ -784,7 +784,7 @@ var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 0.0, 1.0 ] );
784784
var out = arr.reduceRight( reducer, 0 );
785785
// returns 2
786786
```
787-
787+
788788
<a name="method-set"></a>
789789

790790
#### TypedArrayFE.prototype.set( arr\[, offset] )
@@ -947,7 +947,7 @@ var out = arr.with( 0, 0.0 );
947947
var v = out.get( 0 );
948948
// returns 0.0
949949
```
950-
950+
951951
</section>
952952

953953
<!-- /.usage -->

lib/node_modules/@stdlib/assert/is-same-array/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ out = isSameArray( x, y );
9696
## See Also
9797

9898
- <span class="package-name">[`@stdlib/assert/is-array`][@stdlib/assert/is-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array.</span>
99+
- <span class="package-name">[`@stdlib/assert/is-equal-array`][@stdlib/assert/is-equal-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and have equal values.</span>
100+
- <span class="package-name">[`@stdlib/assert/is-same-array-like`][@stdlib/assert/is-same-array-like]</span><span class="delimiter">: </span><span class="description">test if two arguments are both array-like and have the same values.</span>
99101
- <span class="package-name">[`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
100102

101103
</section>
@@ -112,6 +114,10 @@ out = isSameArray( x, y );
112114

113115
[@stdlib/assert/is-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-array
114116

117+
[@stdlib/assert/is-equal-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-array
118+
119+
[@stdlib/assert/is-same-array-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array-like
120+
115121
<!-- </related-links> -->
116122

117123
</section>

lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,10 +170,10 @@ console.log( v );
170170

171171
## See Also
172172

173-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using ordinary recursive summation.</span>
174-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
173+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumors`][@stdlib/blas/ext/base/dapxsumors]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>
174+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
175175
- <span class="package-name">[`@stdlib/blas/ext/base/gsumors`][@stdlib/blas/ext/base/gsumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using ordinary recursive summation.</span>
176-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using ordinary recursive summation.</span>
176+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumors`][@stdlib/blas/ext/base/sapxsumors]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>
177177

178178
</section>
179179

lib/node_modules/@stdlib/iter/strided/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ while ( true ) {
178178

179179
## See Also
180180

181-
- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advances an iterator.</span>
181+
- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advance an iterator.</span>
182182
- <span class="package-name">[`@stdlib/iter/nth`][@stdlib/iter/nth]</span><span class="delimiter">: </span><span class="description">return the nth iterated value.</span>
183183
- <span class="package-name">[`@stdlib/iter/strided-by`][@stdlib/iter/strided-by]</span><span class="delimiter">: </span><span class="description">create an iterator which steps according to a provided callback function.</span>
184184

lib/node_modules/@stdlib/math/base/assert/is-nonpositive-finite/README.md

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

177177
<section class="related">
178178

179+
* * *
180+
181+
## See Also
182+
183+
- <span class="package-name">[`@stdlib/math/base/assert/is-negative-finite`][@stdlib/math/base/assert/is-negative-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is a negative finite number.</span>
184+
- <span class="package-name">[`@stdlib/math/base/assert/is-positive-finite`][@stdlib/math/base/assert/is-positive-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is a positive finite number.</span>
185+
- <span class="package-name">[`@stdlib/math/base/assert/is-nonnegative-finite`][@stdlib/math/base/assert/is-nonnegative-finite]</span><span class="delimiter">: </span><span class="description">test if a numeric value is a nonnegative finite number.</span>
186+
179187
</section>
180188

181189
<!-- /.related -->
@@ -186,6 +194,12 @@ int main( void ) {
186194

187195
<!-- <related-links> -->
188196

197+
[@stdlib/math/base/assert/is-negative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-negative-finite
198+
199+
[@stdlib/math/base/assert/is-positive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-positive-finite
200+
201+
[@stdlib/math/base/assert/is-nonnegative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonnegative-finite
202+
189203
<!-- </related-links> -->
190204

191205
</section>

lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,12 @@ int main( void ) {
174174

175175
<section class="related">
176176

177+
* * *
178+
179+
## See Also
180+
181+
- <span class="package-name">[`@stdlib/math/base/special/log1p`][@stdlib/math/base/special/log1p]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1+x.</span>
182+
177183
</section>
178184

179185
<!-- /.related -->
@@ -188,6 +194,8 @@ int main( void ) {
188194

189195
<!-- <related-links> -->
190196

197+
[@stdlib/math/base/special/log1p]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/log1p
198+
191199
<!-- </related-links> -->
192200

193201
</section>

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,12 @@ int main( void ) {
190190

191191
<section class="related">
192192

193+
* * *
194+
195+
## See Also
196+
197+
- <span class="package-name">[`@stdlib/math/base/special/cbrt`][@stdlib/math/base/special/cbrt]</span><span class="delimiter">: </span><span class="description">compute the cube root of a double-precision floating-point number.</span>
198+
193199
</section>
194200

195201
<!-- /.related -->
@@ -202,6 +208,8 @@ int main( void ) {
202208

203209
<!-- <related-links> -->
204210

211+
[@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt
212+
205213
<!-- </related-links> -->
206214

207215
</section>

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

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

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <span class="package-name">[`@stdlib/math/strided/special/ahaversin-by`][@stdlib/math/strided/special/ahaversin-by]</span><span class="delimiter">: </span><span class="description">compute the inverse half-value versed sine of each element retrieved from an input strided array via a callback function.</span>
237+
232238
</section>
233239

234240
<!-- /.related -->
@@ -243,6 +249,12 @@ console.log( y );
243249

244250
[@stdlib/math/base/special/ahavercos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ahavercos
245251

252+
<!-- <related-links> -->
253+
254+
[@stdlib/math/strided/special/ahaversin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/ahaversin-by
255+
256+
<!-- </related-links> -->
257+
246258
</section>
247259

248260
<!-- /.links -->

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ logEach( '%f', x4 );
359359
## See Also
360360

361361
- <span class="package-name">[`@stdlib/random/base/weibull`][@stdlib/random/base/weibull]</span><span class="delimiter">: </span><span class="description">Weibull distributed pseudorandom numbers.</span>
362+
- <span class="package-name">[`@stdlib/random/strided/weibull`][@stdlib/random/strided/weibull]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Weibull distribution.</span>
362363

363364
</section>
364365

@@ -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/strided/weibull]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/weibull
383+
384+
<!-- </related-links> -->
385+
379386
</section>
380387

381388
<!-- /.links -->

lib/node_modules/@stdlib/string/base/first-code-point/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ str = firstCodePoint( 'अनुच्छेद', 1 );
8888

8989
- <span class="package-name">[`@stdlib/string/base/first`][@stdlib/string/base/first]</span><span class="delimiter">: </span><span class="description">return the first UTF-16 code unit of a string.</span>
9090
- <span class="package-name">[`@stdlib/string/base/first-grapheme-cluster`][@stdlib/string/base/first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the first grapheme cluster (i.e., user-perceived character) of a string.</span>
91+
- <span class="package-name">[`@stdlib/string/base/last-code-point`][@stdlib/string/base/last-code-point]</span><span class="delimiter">: </span><span class="description">return the last Unicode code point of a string.</span>
92+
- <span class="package-name">[`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove the first Unicode code point of a string.</span>
9193
- <span class="package-name">[`@stdlib/string/first`][@stdlib/string/first]</span><span class="delimiter">: </span><span class="description">return the first character(s) of a string.</span>
9294

9395
</section>
@@ -104,6 +106,10 @@ str = firstCodePoint( 'अनुच्छेद', 1 );
104106

105107
[@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-grapheme-cluster
106108

109+
[@stdlib/string/base/last-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last-code-point
110+
111+
[@stdlib/string/base/remove-first-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-code-point
112+
107113
[@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first
108114

109115
<!-- </related-links> -->

0 commit comments

Comments
 (0)