Skip to content

Commit 04720a4

Browse files
committed
docs: update related packages sections
1 parent 911e839 commit 04720a4

File tree

9 files changed

+139
-5
lines changed

9 files changed

+139
-5
lines changed

lib/node_modules/@stdlib/array/little-endian-float64/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,14 @@ logEach( '%s', out );
417417

418418
<section class="related">
419419

420+
* * *
421+
422+
## See Also
423+
424+
- <span class="package-name">[`@stdlib/array/fixed-endian-float64`][@stdlib/array/fixed-endian-float64]</span><span class="delimiter">: </span><span class="description">Float64Array having a specified byte order.</span>
425+
- <span class="package-name">[`@stdlib/array/float64`][@stdlib/array/float64]</span><span class="delimiter">: </span><span class="description">Float64Array.</span>
426+
- <span class="package-name">[`@stdlib/array/little-endian-float32`][@stdlib/array/little-endian-float32]</span><span class="delimiter">: </span><span class="description">Float32Array in little-endian byte order.</span>
427+
420428
</section>
421429

422430
<!-- /.related -->
@@ -433,6 +441,14 @@ logEach( '%s', out );
433441

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

444+
<!-- <related-links> -->
445+
446+
[@stdlib/array/fixed-endian-float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/fixed-endian-float64
447+
448+
[@stdlib/array/little-endian-float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/little-endian-float32
449+
450+
<!-- </related-links> -->
451+
436452
</section>
437453

438454
<!-- /.links -->

lib/node_modules/@stdlib/blas/base/dswap/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,15 @@ int main( void ) {
304304
305305
<section class="related">
306306
307+
* * *
308+
309+
## See Also
310+
311+
- <span class="package-name">[`@stdlib/blas/base/dcopy`][@stdlib/blas/base/dcopy]</span><span class="delimiter">: </span><span class="description">copy values from x into y.</span>
312+
- <span class="package-name">[`@stdlib/blas/base/gswap`][@stdlib/blas/base/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
313+
- <span class="package-name">[`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
314+
- <span class="package-name">[`@stdlib/blas/dswap`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
315+
307316
</section>
308317
309318
<!-- /.related -->
@@ -320,6 +329,18 @@ int main( void ) {
320329
321330
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
322331
332+
<!-- <related-links> -->
333+
334+
[@stdlib/blas/base/dcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dcopy
335+
336+
[@stdlib/blas/base/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/gswap
337+
338+
[@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap
339+
340+
[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap
341+
342+
<!-- </related-links> -->
343+
323344
</section>
324345
325346
<!-- /.links -->

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

+11
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,13 @@ int main( void ) {
170170

171171
<section class="related">
172172

173+
* * *
174+
175+
## See Also
176+
177+
- <span class="package-name">[`@stdlib/math/base/special/tan`][@stdlib/math/base/special/tan]</span><span class="delimiter">: </span><span class="description">evaluate the tangent of a number.</span>
178+
- <span class="package-name">[`@stdlib/math/base/special/cosd`][@stdlib/math/base/special/cosd]</span><span class="delimiter">: </span><span class="description">compute the cosine of an angle measured in degrees.</span>
179+
173180
</section>
174181

175182
<!-- /.related -->
@@ -182,6 +189,10 @@ int main( void ) {
182189

183190
<!-- <related-links> -->
184191

192+
[@stdlib/math/base/special/tan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/tan
193+
194+
[@stdlib/math/base/special/cosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cosd
195+
185196
<!-- </related-links> -->
186197

187198
</section>

lib/node_modules/@stdlib/string/base/capitalize/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ str = capitalize( 'Hidden Treasures' );
7676

7777
<section class="related">
7878

79+
* * *
80+
81+
## See Also
82+
83+
- <span class="package-name">[`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
84+
- <span class="package-name">[`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
85+
7986
</section>
8087

8188
<!-- /.related -->
@@ -84,6 +91,14 @@ str = capitalize( 'Hidden Treasures' );
8491

8592
<section class="links">
8693

94+
<!-- <related-links> -->
95+
96+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
97+
98+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
99+
100+
<!-- </related-links> -->
101+
87102
</section>
88103

89104
<!-- /.links -->

lib/node_modules/@stdlib/string/base/format-interpolate/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ out = formatInterpolate( tokens, 0, 'foo' );
103103

104104
<section class="related">
105105

106+
* * *
107+
108+
## See Also
109+
110+
- <span class="package-name">[`@stdlib/string/base/format-tokenize`][@stdlib/string/base/format-tokenize]</span><span class="delimiter">: </span><span class="description">tokenize a string into an array of string parts and format identifier objects.</span>
111+
106112
</section>
107113

108114
<!-- /.related -->
@@ -111,6 +117,12 @@ out = formatInterpolate( tokens, 0, 'foo' );
111117

112118
<section class="links">
113119

120+
<!-- <related-links> -->
121+
122+
[@stdlib/string/base/format-tokenize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/format-tokenize
123+
124+
<!-- </related-links> -->
125+
114126
</section>
115127

116128
<!-- /.links -->

lib/node_modules/@stdlib/string/base/last/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,12 @@ str = last( 'good night', 5 );
8181

8282
* * *
8383

84+
## See Also
85+
86+
- <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>
87+
- <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>
88+
- <span class="package-name">[`@stdlib/string/base/last-grapheme-cluster`][@stdlib/string/base/last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the last grapheme cluster (i.e., user-perceived character) of a string.</span>
89+
8490
</section>
8591

8692
<!-- /.related -->
@@ -91,6 +97,12 @@ str = last( 'good night', 5 );
9197

9298
<!-- <related-links> -->
9399

100+
[@stdlib/string/base/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first
101+
102+
[@stdlib/string/base/last-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last-code-point
103+
104+
[@stdlib/string/base/last-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last-grapheme-cluster
105+
94106
<!-- </related-links> -->
95107

96108
</section>

lib/node_modules/@stdlib/string/base/pascalcase/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,14 @@ out = pascalcase( str );
8484

8585
<section class="related">
8686

87+
* * *
88+
89+
## See Also
90+
91+
- <span class="package-name">[`@stdlib/string/base/camelcase`][@stdlib/string/base/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
92+
- <span class="package-name">[`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
93+
- <span class="package-name">[`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
94+
8795
</section>
8896

8997
<!-- /.related -->
@@ -92,6 +100,16 @@ out = pascalcase( str );
92100

93101
<section class="links">
94102

103+
<!-- <related-links> -->
104+
105+
[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase
106+
107+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
108+
109+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
110+
111+
<!-- </related-links> -->
112+
95113
</section>
96114

97115
<!-- /.links -->

lib/node_modules/@stdlib/string/base/remove-last/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@ str = removeLast( 'The Last of the Mohicans', 5 );
7979

8080
<section class="related">
8181

82+
* * *
83+
84+
## See Also
85+
86+
- <span class="package-name">[`@stdlib/string/base/remove-last-code-point`][@stdlib/string/base/remove-last-code-point]</span><span class="delimiter">: </span><span class="description">remove the last Unicode code point of a string.</span>
87+
- <span class="package-name">[`@stdlib/string/base/remove-last-grapheme-cluster`][@stdlib/string/base/remove-last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the last grapheme cluster (i.e., user-perceived character) of a string.</span>
88+
- <span class="package-name">[`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first UTF-16 code unit of a string.</span>
89+
8290
</section>
8391

8492
<!-- /.related -->
@@ -87,6 +95,16 @@ str = removeLast( 'The Last of the Mohicans', 5 );
8795

8896
<section class="links">
8997

98+
<!-- <related-links> -->
99+
100+
[@stdlib/string/base/remove-last-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last-code-point
101+
102+
[@stdlib/string/base/remove-last-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last-grapheme-cluster
103+
104+
[@stdlib/string/base/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first
105+
106+
<!-- </related-links> -->
107+
90108
</section>
91109

92110
<!-- /.links -->

lib/node_modules/@stdlib/utils/some-in-by/README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -202,11 +202,10 @@ bool = someInBy( obj, 5, threshold );
202202

203203
## See Also
204204

205-
- <span class="package-name">[`@stdlib/utils/any-by`][@stdlib/utils/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
206-
- <span class="package-name">[`@stdlib/utils/every-by`][@stdlib/utils/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</span>
207-
- <span class="package-name">[`@stdlib/utils/none-by`][@stdlib/utils/none-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection fail a test implemented by a predicate function.</span>
208-
- <span class="package-name">[`@stdlib/utils/async/some-by`][@stdlib/utils/async/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains `n` elements which pass a test implemented by a predicate function.</span>
209-
- <span class="package-name">[`@stdlib/utils/some-by-right`][@stdlib/utils/some-by-right]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.</span>
205+
- <span class="package-name">[`@stdlib/utils/any-in-by`][@stdlib/utils/any-in-by]</span><span class="delimiter">: </span><span class="description">test whether at least one property in an object passes a test implemented by a predicate function.</span>
206+
- <span class="package-name">[`@stdlib/utils/every-in-by`][@stdlib/utils/every-in-by]</span><span class="delimiter">: </span><span class="description">test whether all properties (own and inherited) of an object pass a test implemented by a predicate function.</span>
207+
- <span class="package-name">[`@stdlib/utils/some-by`][@stdlib/utils/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
208+
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>
210209

211210
</section>
212211

@@ -229,6 +228,18 @@ bool = someInBy( obj, 5, threshold );
229228

230229
<!-- </related-links> -->
231230

231+
<!-- <related-links> -->
232+
233+
[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by
234+
235+
[@stdlib/utils/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-in-by
236+
237+
[@stdlib/utils/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-by
238+
239+
[@stdlib/utils/some-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-own-by
240+
241+
<!-- </related-links> -->
242+
232243
</section>
233244

234245
<!-- /.links -->

0 commit comments

Comments
 (0)