Skip to content

Commit b8c41df

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#3915 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent e43aaa9 commit b8c41df

File tree

13 files changed

+154
-3
lines changed

13 files changed

+154
-3
lines changed

‎lib/node_modules/@stdlib/array/base/flatten2d-by/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,12 @@ out = flatten2dBy( x, [ 4, 4 ], true, fcn );
185185

186186
<section class="related">
187187

188+
* * *
189+
190+
## See Also
191+
192+
- <span class="package-name">[`@stdlib/array/base/flatten2d`][@stdlib/array/base/flatten2d]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array.</span>
193+
188194
</section>
189195

190196
<!-- /.related -->
@@ -193,6 +199,12 @@ out = flatten2dBy( x, [ 4, 4 ], true, fcn );
193199

194200
<section class="links">
195201

202+
<!-- <related-links> -->
203+
204+
[@stdlib/array/base/flatten2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d
205+
206+
<!-- </related-links> -->
207+
196208
</section>
197209

198210
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/has-atob-support/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ $ has-atob-support
108108

109109
<section class="related">
110110

111+
* * *
112+
113+
## See Also
114+
115+
- <span class="package-name">[`@stdlib/assert/has-btoa-support`][@stdlib/assert/has-btoa-support]</span><span class="delimiter">: </span><span class="description">detect native btoa support.</span>
116+
111117
</section>
112118

113119
<!-- /.related -->
@@ -118,6 +124,12 @@ $ has-atob-support
118124

119125
[mdn-atob]: https://developer.mozilla.org/en-US/docs/Web/API/Window/atob
120126

127+
<!-- <related-links> -->
128+
129+
[@stdlib/assert/has-btoa-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-btoa-support
130+
131+
<!-- </related-links> -->
132+
121133
</section>
122134

123135
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-ndarray-like-with-data-type/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ bool = isndarrayLikeWithDataType( null, 'generic' );
7878

7979
<section class="related">
8080

81+
* * *
82+
83+
## See Also
84+
85+
- <span class="package-name">[`@stdlib/assert/is-ndarray-like`][@stdlib/assert/is-ndarray-like]</span><span class="delimiter">: </span><span class="description">test if a value is ndarray-like.</span>
86+
8187
</section>
8288

8389
<!-- /.related -->

‎lib/node_modules/@stdlib/blas/base/dscal/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,10 +281,10 @@ int main( void ) {
281281
282282
## See Also
283283
284-
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
284+
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
285285
- <span class="package-name">[`@stdlib/blas/base/gscal`][@stdlib/blas/base/gscal]</span><span class="delimiter">: </span><span class="description">multiply a vector by a constant.</span>
286286
- <span class="package-name">[`@stdlib/blas/base/sscal`][@stdlib/blas/base/sscal]</span><span class="delimiter">: </span><span class="description">multiply a single-precision floating-point vector by a constant.</span>
287-
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
287+
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
288288
289289
</section>
290290

‎lib/node_modules/@stdlib/blas/base/sswap/README.md‎

Lines changed: 21 additions & 0 deletions
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/dswap`][@stdlib/blas/base/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</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/scopy`][@stdlib/blas/base/scopy]</span><span class="delimiter">: </span><span class="description">copy values from x into y.</span>
314+
- <span class="package-name">[`@stdlib/blas/sswap`][@stdlib/blas/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-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/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dswap
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/scopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/scopy
339+
340+
[@stdlib/blas/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/sswap
341+
342+
<!-- </related-links> -->
343+
323344
</section>
324345
325346
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float64/high-word-significand-mask/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ Macro for the high word mask for the significand of a [double-precision floating
150150
## See Also
151151

152152
- <span class="package-name">[`@stdlib/constants/float64/high-word-exponent-mask`][@stdlib/constants/float64/high-word-exponent-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the exponent of a double-precision floating-point number.</span>
153+
- <span class="package-name">[`@stdlib/constants/float64/high-word-sign-mask`][@stdlib/constants/float64/high-word-sign-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the sign bit of a double-precision floating-point number.</span>
154+
- <span class="package-name">[`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]</span><span class="delimiter">: </span><span class="description">high word mask for excluding the sign bit of a double-precision floating-point number.</span>
153155

154156
</section>
155157

@@ -165,6 +167,10 @@ Macro for the high word mask for the significand of a [double-precision floating
165167

166168
[@stdlib/constants/float64/high-word-exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-exponent-mask
167169

170+
[@stdlib/constants/float64/high-word-sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-sign-mask
171+
172+
[@stdlib/constants/float64/high-word-abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-abs-mask
173+
168174
<!-- </related-links> -->
169175

170176
</section>

‎lib/node_modules/@stdlib/math/base/special/acosf/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,15 @@ int main( void ) {
173173

174174
<section class="related">
175175

176+
* * *
177+
178+
## See Also
179+
180+
- <span class="package-name">[`@stdlib/math/base/special/acos`][@stdlib/math/base/special/acos]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a double-precision floating-point number.</span>
181+
- <span class="package-name">[`@stdlib/math/base/special/acosh`][@stdlib/math/base/special/acosh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosine of a double-precision floating-point number.</span>
182+
- <span class="package-name">[`@stdlib/math/base/special/asinf`][@stdlib/math/base/special/asinf]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a single-precision floating-point number.</span>
183+
- <span class="package-name">[`@stdlib/math/base/special/atanf`][@stdlib/math/base/special/atanf]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a single-precision floating-point number.</span>
184+
176185
</section>
177186

178187
<!-- /.related -->
@@ -183,6 +192,18 @@ int main( void ) {
183192

184193
[arccosine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
185194

195+
<!-- <related-links> -->
196+
197+
[@stdlib/math/base/special/acos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acos
198+
199+
[@stdlib/math/base/special/acosh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosh
200+
201+
[@stdlib/math/base/special/asinf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinf
202+
203+
[@stdlib/math/base/special/atanf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanf
204+
205+
<!-- </related-links> -->
206+
186207
</section>
187208

188209
<!-- /.links -->

‎lib/node_modules/@stdlib/math/strided/ops/mul-by/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,14 @@ console.log( z );
241241

242242
<section class="related">
243243

244+
* * *
245+
246+
## See Also
247+
248+
- <span class="package-name">[`@stdlib/math/strided/ops/mul`][@stdlib/math/strided/ops/mul]</span><span class="delimiter">: </span><span class="description">element-wise multiplication of two strided arrays.</span>
249+
- <span class="package-name">[`@stdlib/math/strided/ops/add-by`][@stdlib/math/strided/ops/add-by]</span><span class="delimiter">: </span><span class="description">element-wise addition of two strided arrays via a callback function.</span>
250+
- <span class="package-name">[`@stdlib/math/strided/ops/sub-by`][@stdlib/math/strided/ops/sub-by]</span><span class="delimiter">: </span><span class="description">element-wise subtraction of two strided arrays via a callback function.</span>
251+
244252
</section>
245253

246254
<!-- /.related -->
@@ -255,6 +263,16 @@ console.log( z );
255263

256264
[@stdlib/math/base/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul
257265

266+
<!-- <related-links> -->
267+
268+
[@stdlib/math/strided/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/mul
269+
270+
[@stdlib/math/strided/ops/add-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/add-by
271+
272+
[@stdlib/math/strided/ops/sub-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/sub-by
273+
274+
<!-- </related-links> -->
275+
258276
</section>
259277

260278
<!-- /.links -->

‎lib/node_modules/@stdlib/regexp/semver/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,12 @@ bool = RE_SEMVER.test( version );
142142

143143
<section class="related">
144144

145+
* * *
146+
147+
## See Also
148+
149+
- <span class="package-name">[`@stdlib/assert/is-semver`][@stdlib/assert/is-semver]</span><span class="delimiter">: </span><span class="description">test if a value is a semantic version string.</span>
150+
145151
</section>
146152

147153
<!-- /.related -->
@@ -156,6 +162,8 @@ bool = RE_SEMVER.test( version );
156162

157163
<!-- <related-links> -->
158164

165+
[@stdlib/assert/is-semver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-semver
166+
159167
<!-- </related-links> -->
160168

161169
</section>

‎lib/node_modules/@stdlib/slice/base/int2slice/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,13 @@ console.log( '%s', s.toString() );
128128

129129
<section class="related">
130130

131+
* * *
132+
133+
## See Also
134+
135+
- <span class="package-name">[`@stdlib/slice/base/seq2slice`][@stdlib/slice/base/seq2slice]</span><span class="delimiter">: </span><span class="description">convert a subsequence string to a Slice object.</span>
136+
- <span class="package-name">[`@stdlib/slice/base/str2slice`][@stdlib/slice/base/str2slice]</span><span class="delimiter">: </span><span class="description">parse a string-serialized Slice object.</span>
137+
131138
</section>
132139

133140
<!-- /.related -->
@@ -138,6 +145,14 @@ console.log( '%s', s.toString() );
138145

139146
[@stdlib/slice/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/ctor
140147

148+
<!-- <related-links> -->
149+
150+
[@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2slice
151+
152+
[@stdlib/slice/base/str2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2slice
153+
154+
<!-- </related-links> -->
155+
141156
</section>
142157

143158
<!-- /.links -->

0 commit comments

Comments
 (0)