Skip to content

Commit a1b543a

Browse files
docs: update related packages sections
PR-URL: #4009 Reviewed-by: Athan Reines <kgryte@gmail.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent fd27b52 commit a1b543a

File tree

10 files changed

+146
-0
lines changed

10 files changed

+146
-0
lines changed

Diff for: lib/node_modules/@stdlib/array/base/filled5d-by/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );
134134

135135
<section class="related">
136136

137+
* * *
138+
139+
## See Also
140+
141+
- <span class="package-name">[`@stdlib/array/base/filled5d`][@stdlib/array/base/filled5d]</span><span class="delimiter">: </span><span class="description">create a filled five-dimensional nested array.</span>
142+
137143
</section>
138144

139145
<!-- /.related -->
@@ -142,6 +148,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );
142148

143149
<section class="links">
144150

151+
<!-- <related-links> -->
152+
153+
[@stdlib/array/base/filled5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled5d
154+
155+
<!-- </related-links> -->
156+
145157
</section>
146158

147159
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/array/base/flatten5d/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,12 @@ out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
154154

155155
<section class="related">
156156

157+
* * *
158+
159+
## See Also
160+
161+
- <span class="package-name">[`@stdlib/array/base/flatten5d-by`][@stdlib/array/base/flatten5d-by]</span><span class="delimiter">: </span><span class="description">flatten a five-dimensional nested array according to a callback function.</span>
162+
157163
</section>
158164

159165
<!-- /.related -->
@@ -162,6 +168,12 @@ out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
162168

163169
<section class="links">
164170

171+
<!-- <related-links> -->
172+
173+
[@stdlib/array/base/flatten5d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by
174+
175+
<!-- </related-links> -->
176+
165177
</section>
166178

167179
<!-- /.links -->

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

+11
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,13 @@ false
169169

170170
<section class="related">
171171

172+
* * *
173+
174+
## See Also
175+
176+
- <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
177+
- <span class="package-name">[`@stdlib/assert/is-constantcase`][@stdlib/assert/is-constantcase]</span><span class="delimiter">: </span><span class="description">test if a value is a constant-case string.</span>
178+
172179
</section>
173180

174181
<!-- /.related -->
@@ -183,6 +190,10 @@ false
183190

184191
<!-- <related-links> -->
185192

193+
[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
194+
195+
[@stdlib/assert/is-constantcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-constantcase
196+
186197
<!-- </related-links> -->
187198

188199
</section>

Diff for: lib/node_modules/@stdlib/iter/do-until-each/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,14 @@ while ( true ) {
223223

224224
<section class="related">
225225

226+
* * *
227+
228+
## See Also
229+
230+
- <span class="package-name">[`@stdlib/iter/do-while-each`][@stdlib/iter/do-while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>
231+
- <span class="package-name">[`@stdlib/iter/until-each`][@stdlib/iter/until-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.</span>
232+
- <span class="package-name">[`@stdlib/iter/while-each`][@stdlib/iter/while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>
233+
226234
</section>
227235

228236
<!-- /.related -->
@@ -231,6 +239,16 @@ while ( true ) {
231239

232240
<section class="links">
233241

242+
<!-- <related-links> -->
243+
244+
[@stdlib/iter/do-while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-while-each
245+
246+
[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each
247+
248+
[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each
249+
250+
<!-- </related-links> -->
251+
234252
</section>
235253

236254
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/math/strided/special/asinh-by/README.md

+12
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/asin-by`][@stdlib/math/strided/special/asin-by]</span><span class="delimiter">: </span><span class="description">compute the arcsine 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/asinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinh
245251

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

248260
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/ndarray/map/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,14 @@ console.log( ndarray2array( y ) );
233233

234234
<section class="related">
235235

236+
* * *
237+
238+
## See Also
239+
240+
- <span class="package-name">[`@stdlib/ndarray/filter`][@stdlib/ndarray/filter]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
241+
- <span class="package-name">[`@stdlib/ndarray/filter-map`][@stdlib/ndarray/filter-map]</span><span class="delimiter">: </span><span class="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function.</span>
242+
- <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>
243+
236244
</section>
237245

238246
<!-- /.related -->
@@ -247,6 +255,12 @@ console.log( ndarray2array( y ) );
247255

248256
<!-- <related-links> -->
249257

258+
[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter
259+
260+
[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map
261+
262+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
263+
250264
<!-- </related-links> -->
251265

252266
</section>

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

+15
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ out = altcase( str );
8989

9090
<section class="related">
9191

92+
* * *
93+
94+
## See Also
95+
96+
- <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>
97+
- <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>
98+
9299
</section>
93100

94101
<!-- /.related -->
@@ -97,6 +104,14 @@ out = altcase( str );
97104

98105
<section class="links">
99106

107+
<!-- <related-links> -->
108+
109+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
110+
111+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
112+
113+
<!-- </related-links> -->
114+
100115
</section>
101116

102117
<!-- /.links -->

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

+21
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,15 @@ out = constantcase( str );
8989

9090
<section class="related">
9191

92+
* * *
93+
94+
## See Also
95+
96+
- <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>
97+
- <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>
98+
- <span class="package-name">[`@stdlib/string/base/snakecase`][@stdlib/string/base/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
99+
- <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>
100+
92101
</section>
93102

94103
<!-- /.related -->
@@ -97,6 +106,18 @@ out = constantcase( str );
97106

98107
<section class="links">
99108

109+
<!-- <related-links> -->
110+
111+
[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase
112+
113+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
114+
115+
[@stdlib/string/base/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/snakecase
116+
117+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
118+
119+
<!-- </related-links> -->
120+
100121
</section>
101122

102123
<!-- /.links -->

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

+15
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ out = trim( '\n\n\nNew Lines\n\n\n' );
9696

9797
<section class="related">
9898

99+
* * *
100+
101+
## See Also
102+
103+
- <span class="package-name">[`@stdlib/string/base/left-trim`][@stdlib/string/base/left-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning of a string.</span>
104+
- <span class="package-name">[`@stdlib/string/base/right-trim`][@stdlib/string/base/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>
105+
99106
</section>
100107

101108
<!-- /.related -->
@@ -106,6 +113,14 @@ out = trim( '\n\n\nNew Lines\n\n\n' );
106113

107114
[unicode]: https://en.wikipedia.org/wiki/Unicode
108115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/string/base/left-trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/left-trim
119+
120+
[@stdlib/string/base/right-trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/right-trim
121+
122+
<!-- </related-links> -->
123+
109124
</section>
110125

111126
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/utils/none-in-by/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,12 @@ var bool = noneInBy( obj, isUnderage );
211211

212212
## See Also
213213

214+
- <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>
215+
- <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>
216+
- <span class="package-name">[`@stdlib/utils/for-in`][@stdlib/utils/for-in]</span><span class="delimiter">: </span><span class="description">invoke a function for each own and inherited enumerable property of an object.</span>
217+
- <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>
218+
- <span class="package-name">[`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]</span><span class="delimiter">: </span><span class="description">test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.</span>
219+
214220
</section>
215221

216222
<!-- /.related -->
@@ -221,6 +227,16 @@ var bool = noneInBy( obj, isUnderage );
221227

222228
<!-- <related-links> -->
223229

230+
[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by
231+
232+
[@stdlib/utils/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-in-by
233+
234+
[@stdlib/utils/for-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/for-in
235+
236+
[@stdlib/utils/none-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-by
237+
238+
[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by
239+
224240
<!-- </related-links> -->
225241

226242
</section>

0 commit comments

Comments
 (0)