Skip to content

Commit 9d35712

Browse files
PlaneshifterPlaneshifter
committed
Populate "See Also" sections
1 parent 8b19a7c commit 9d35712

File tree

166 files changed

+3109
-18
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+3109
-18
lines changed

‎lib/node_modules/@stdlib/array/buffer/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -234,15 +234,15 @@ for ( i = 0; i < bytes.length; i++ ) {
234234

235235
- [`@stdlib/buffer/ctor`][@stdlib/buffer/ctor]: buffer.
236236
- [`@stdlib/array/float32`][@stdlib/array/float32]: float32Array.
237-
- [`@stdlib/array/float64`][@stdlib/array/float64]: float64Array.
238-
- [`@stdlib/array/int16`][@stdlib/array/int16]: int16Array.
239-
- [`@stdlib/array/int32`][@stdlib/array/int32]: int32Array.
240-
- [`@stdlib/array/int8`][@stdlib/array/int8]: int8Array.
237+
- [`@stdlib/array/float64`][@stdlib/array/float64]: Float64Array.
238+
- [`@stdlib/array/int16`][@stdlib/array/int16]: Int16Array.
239+
- [`@stdlib/array/int32`][@stdlib/array/int32]: Int32Array.
240+
- [`@stdlib/array/int8`][@stdlib/array/int8]: Int8Array.
241241
- [`@stdlib/array/shared-buffer`][@stdlib/array/shared-buffer]: sharedArrayBuffer.
242-
- [`@stdlib/array/uint16`][@stdlib/array/uint16]: uint16Array.
243-
- [`@stdlib/array/uint32`][@stdlib/array/uint32]: uint32Array.
244-
- [`@stdlib/array/uint8`][@stdlib/array/uint8]: uint8Array.
245-
- [`@stdlib/array/uint8c`][@stdlib/array/uint8c]: uint8ClampedArray.
242+
- [`@stdlib/array/uint16`][@stdlib/array/uint16]: Uint16Array.
243+
- [`@stdlib/array/uint32`][@stdlib/array/uint32]: Uint32Array.
244+
- [`@stdlib/array/uint8`][@stdlib/array/uint8]: Uint8Array.
245+
- [`@stdlib/array/uint8c`][@stdlib/array/uint8c]: Uint8ClampedArray.
246246

247247
</section>
248248

‎lib/node_modules/@stdlib/iter/advance/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,13 @@ var len = iterLength( it2 );
158158

159159
<section class="related">
160160

161+
* * *
162+
163+
## See Also
164+
165+
- [`@stdlib/iter/head`][@stdlib/iter/head]: create an iterator which returns the first `n` values of a provided iterator.
166+
- [`@stdlib/iter/slice`][@stdlib/iter/slice]: create an iterator which returns a subsequence of iterated values from a provided iterator.
167+
161168
</section>
162169

163170
<!-- /.related -->
@@ -168,6 +175,14 @@ var len = iterLength( it2 );
168175

169176
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
170177

178+
<!-- <related-links> -->
179+
180+
[@stdlib/iter/head]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/head
181+
182+
[@stdlib/iter/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/slice
183+
184+
<!-- </related-links> -->
185+
171186
</section>
172187

173188
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/any-by/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,16 @@ console.log( bool );
159159

160160
<section class="related">
161161

162+
* * *
163+
164+
## See Also
165+
166+
- [`@stdlib/iter/any`][@stdlib/iter/any]: test whether at least one iterated value is truthy.
167+
- [`@stdlib/iter/every-by`][@stdlib/iter/every-by]: test whether every iterated value passes a test implemented by a predicate function.
168+
- [`@stdlib/iter/for-each`][@stdlib/iter/for-each]: create an iterator which invokes a function for each iterated value before returning the iterated value.
169+
- [`@stdlib/iter/none-by`][@stdlib/iter/none-by]: test whether every iterated value fails a test implemented by a predicate function.
170+
- [`@stdlib/iter/some-by`][@stdlib/iter/some-by]: test whether at least `n` iterated values pass a test implemented by a predicate function.
171+
162172
</section>
163173

164174
<!-- /.related -->
@@ -169,6 +179,20 @@ console.log( bool );
169179

170180
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
171181

182+
<!-- <related-links> -->
183+
184+
[@stdlib/iter/any]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/any
185+
186+
[@stdlib/iter/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/every-by
187+
188+
[@stdlib/iter/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/for-each
189+
190+
[@stdlib/iter/none-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/none-by
191+
192+
[@stdlib/iter/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/some-by
193+
194+
<!-- </related-links> -->
195+
172196
</section>
173197

174198
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/any/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,16 @@ console.log( bool );
123123

124124
<section class="related">
125125

126+
* * *
127+
128+
## See Also
129+
130+
- [`@stdlib/iter/any-by`][@stdlib/iter/any-by]: test whether at least one iterated value passes a test implemented by a predicate function.
131+
- [`@stdlib/iter/every`][@stdlib/iter/every]: test whether all iterated values are truthy.
132+
- [`@stdlib/iter/for-each`][@stdlib/iter/for-each]: create an iterator which invokes a function for each iterated value before returning the iterated value.
133+
- [`@stdlib/iter/none`][@stdlib/iter/none]: test whether all iterated values are falsy.
134+
- [`@stdlib/iter/some`][@stdlib/iter/some]: test whether at least `n` iterated values are truthy.
135+
126136
</section>
127137

128138
<!-- /.related -->
@@ -133,6 +143,20 @@ console.log( bool );
133143

134144
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
135145

146+
<!-- <related-links> -->
147+
148+
[@stdlib/iter/any-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/any-by
149+
150+
[@stdlib/iter/every]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/every
151+
152+
[@stdlib/iter/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/for-each
153+
154+
[@stdlib/iter/none]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/none
155+
156+
[@stdlib/iter/some]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/some
157+
158+
<!-- </related-links> -->
159+
136160
</section>
137161

138162
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/constant/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,12 @@ while ( true ) {
174174

175175
<section class="related">
176176

177+
* * *
178+
179+
## See Also
180+
181+
- [`@stdlib/utils/constant-function`][@stdlib/utils/constant-function]: constant function.
182+
177183
</section>
178184

179185
<!-- /.related -->
@@ -182,6 +188,12 @@ while ( true ) {
182188

183189
<section class="links">
184190

191+
<!-- <related-links> -->
192+
193+
[@stdlib/utils/constant-function]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/constant-function
194+
195+
<!-- </related-links> -->
196+
185197
</section>
186198

187199
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/counter/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,12 @@ while ( true ) {
131131

132132
<section class="related">
133133

134+
* * *
135+
136+
## See Also
137+
138+
- [`@stdlib/iter/length`][@stdlib/iter/length]: return an iterator's length.
139+
134140
</section>
135141

136142
<!-- /.related -->
@@ -141,6 +147,12 @@ while ( true ) {
141147

142148
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
143149

150+
<!-- <related-links> -->
151+
152+
[@stdlib/iter/length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/length
153+
154+
<!-- </related-links> -->
155+
144156
</section>
145157

146158
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/datespace/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,16 @@ while ( true ) {
208208

209209
<section class="related">
210210

211+
* * *
212+
213+
## See Also
214+
215+
- [`@stdlib/array/from-iterator`][@stdlib/array/from-iterator]: create (or fill) an array from an iterator.
216+
- [`@stdlib/iter/incrspace`][@stdlib/iter/incrspace]: create an iterator which returns evenly spaced numbers according to a specified increment.
217+
- [`@stdlib/iter/linspace`][@stdlib/iter/linspace]: create an iterator which returns evenly spaced numbers over a specified interval.
218+
- [`@stdlib/iter/logspace`][@stdlib/iter/logspace]: create an iterator which returns evenly spaced numbers on a log scale.
219+
- [`@stdlib/iter/step`][@stdlib/iter/step]: create an iterator which returns a sequence of numbers according to a specified increment.
220+
211221
</section>
212222

213223
<!-- /.related -->
@@ -216,6 +226,20 @@ while ( true ) {
216226

217227
<section class="links">
218228

229+
<!-- <related-links> -->
230+
231+
[@stdlib/array/from-iterator]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/from-iterator
232+
233+
[@stdlib/iter/incrspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/incrspace
234+
235+
[@stdlib/iter/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/linspace
236+
237+
[@stdlib/iter/logspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/logspace
238+
239+
[@stdlib/iter/step]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/step
240+
241+
<!-- </related-links> -->
242+
219243
</section>
220244

221245
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/dedupe-by/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,13 @@ while ( true ) {
230230

231231
<section class="related">
232232

233+
* * *
234+
235+
## See Also
236+
237+
- [`@stdlib/iter/dedupe`][@stdlib/iter/dedupe]: create an iterator which removes consecutive duplicated values.
238+
- [`@stdlib/iter/unique`][@stdlib/iter/unique]: create an iterator which returns unique values.
239+
233240
</section>
234241

235242
<!-- /.related -->
@@ -240,6 +247,14 @@ while ( true ) {
240247

241248
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
242249

250+
<!-- <related-links> -->
251+
252+
[@stdlib/iter/dedupe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/dedupe
253+
254+
[@stdlib/iter/unique]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/unique
255+
256+
<!-- </related-links> -->
257+
243258
</section>
244259

245260
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/dedupe/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,13 @@ while ( true ) {
240240

241241
<section class="related">
242242

243+
* * *
244+
245+
## See Also
246+
247+
- [`@stdlib/iter/dedupe-by`][@stdlib/iter/dedupe-by]: create an iterator which removes consecutive values that resolve to the same value according to a provided function.
248+
- [`@stdlib/iter/unique`][@stdlib/iter/unique]: create an iterator which returns unique values.
249+
243250
</section>
244251

245252
<!-- /.related -->
@@ -250,6 +257,14 @@ while ( true ) {
250257

251258
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
252259

260+
<!-- <related-links> -->
261+
262+
[@stdlib/iter/dedupe-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/dedupe-by
263+
264+
[@stdlib/iter/unique]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/unique
265+
266+
<!-- </related-links> -->
267+
253268
</section>
254269

255270
<!-- /.links -->

‎lib/node_modules/@stdlib/iter/empty/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,12 @@ while ( true ) {
116116

117117
<section class="related">
118118

119+
* * *
120+
121+
## See Also
122+
123+
- [`@stdlib/iter/constant`][@stdlib/iter/constant]: create an iterator which always returns the same value.
124+
119125
</section>
120126

121127
<!-- /.related -->
@@ -124,6 +130,12 @@ while ( true ) {
124130

125131
<section class="links">
126132

133+
<!-- <related-links> -->
134+
135+
[@stdlib/iter/constant]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/constant
136+
137+
<!-- </related-links> -->
138+
127139
</section>
128140

129141
<!-- /.links -->

0 commit comments

Comments
 (0)