Skip to content

Commit 1c56b73

Browse files
authored
docs: update related packages sections
PR-URL: #3380 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 4ec80d0 commit 1c56b73

File tree

12 files changed

+153
-2
lines changed

12 files changed

+153
-2
lines changed

lib/node_modules/@stdlib/array/bool/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1833,6 +1833,12 @@ console.log( '%s', false );
18331833

18341834
<section class="related">
18351835

1836+
* * *
1837+
1838+
## See Also
1839+
1840+
- <span class="package-name">[`@stdlib/array/buffer`][@stdlib/array/buffer]</span><span class="delimiter">: </span><span class="description">ArrayBuffer.</span>
1841+
18361842
</section>
18371843

18381844
<!-- /.related -->

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

+13
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,13 @@ logEach( '%s', out );
422422

423423
<section class="related">
424424

425+
* * *
426+
427+
## See Also
428+
429+
- <span class="package-name">[`@stdlib/array/fixed-endian-float32`][@stdlib/array/fixed-endian-float32]</span><span class="delimiter">: </span><span class="description">Float32Array having a specified byte order.</span>
430+
- <span class="package-name">[`@stdlib/array/float64`][@stdlib/array/float64]</span><span class="delimiter">: </span><span class="description">Float64Array.</span>
431+
425432
</section>
426433

427434
<!-- /.related -->
@@ -438,6 +445,12 @@ logEach( '%s', out );
438445

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

448+
<!-- <related-links> -->
449+
450+
[@stdlib/array/fixed-endian-float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/fixed-endian-float32
451+
452+
<!-- </related-links> -->
453+
441454
</section>
442455

443456
<!-- /.links -->

lib/node_modules/@stdlib/array/mskput/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,14 @@ console.log( out );
146146

147147
<section class="related">
148148

149+
* * *
150+
151+
## See Also
152+
153+
- <span class="package-name">[`@stdlib/array/place`][@stdlib/array/place]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
154+
- <span class="package-name">[`@stdlib/array/put`][@stdlib/array/put]</span><span class="delimiter">: </span><span class="description">replace specified elements of an array with provided values.</span>
155+
- <span class="package-name">[`@stdlib/array/take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>
156+
149157
</section>
150158

151159
<!-- /.related -->
@@ -160,6 +168,16 @@ console.log( out );
160168

161169
[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/same-kind-casts
162170

171+
<!-- <related-links> -->
172+
173+
[@stdlib/array/place]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/place
174+
175+
[@stdlib/array/put]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/put
176+
177+
[@stdlib/array/take]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/take
178+
179+
<!-- </related-links> -->
180+
163181
</section>
164182

165183
<!-- /.links -->

lib/node_modules/@stdlib/array/put/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,14 @@ console.log( out );
147147

148148
<section class="related">
149149

150+
* * *
151+
152+
## See Also
153+
154+
- <span class="package-name">[`@stdlib/array/mskput`][@stdlib/array/mskput]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
155+
- <span class="package-name">[`@stdlib/array/place`][@stdlib/array/place]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
156+
- <span class="package-name">[`@stdlib/array/take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>
157+
150158
</section>
151159

152160
<!-- /.related -->
@@ -165,6 +173,16 @@ console.log( out );
165173

166174
[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/same-kind-casts
167175

176+
<!-- <related-links> -->
177+
178+
[@stdlib/array/mskput]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskput
179+
180+
[@stdlib/array/place]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/place
181+
182+
[@stdlib/array/take]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/take
183+
184+
<!-- </related-links> -->
185+
168186
</section>
169187

170188
<!-- /.links -->

lib/node_modules/@stdlib/blas/sdot/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,14 @@ console.log( ndarray2array( z ) );
154154

155155
<section class="related">
156156

157+
* * *
158+
159+
## See Also
160+
161+
- <span class="package-name">[`@stdlib/blas/base/sdot`][@stdlib/blas/base/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
162+
- <span class="package-name">[`@stdlib/blas/ddot`][@stdlib/blas/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
163+
- <span class="package-name">[`@stdlib/blas/gdot`][@stdlib/blas/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two vectors.</span>
164+
157165
</section>
158166

159167
<!-- /.related -->
@@ -172,6 +180,14 @@ console.log( ndarray2array( z ) );
172180

173181
[@stdlib/blas/base/sdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sdot
174182

183+
<!-- <related-links> -->
184+
185+
[@stdlib/blas/ddot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ddot
186+
187+
[@stdlib/blas/gdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/gdot
188+
189+
<!-- </related-links> -->
190+
175191
</section>
176192

177193
<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/significand-mask/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,14 @@ Macro for the mask for the significand of a [single-precision floating-point num
139139

140140
<section class="related">
141141

142+
* * *
143+
144+
## See Also
145+
146+
- <span class="package-name">[`@stdlib/constants/float32/exponent-mask`][@stdlib/constants/float32/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a single-precision floating-point number.</span>
147+
- <span class="package-name">[`@stdlib/constants/float32/sign-mask`][@stdlib/constants/float32/sign-mask]</span><span class="delimiter">: </span><span class="description">mask for the sign bit of a single-precision floating-point number.</span>
148+
- <span class="package-name">[`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]</span><span class="delimiter">: </span><span class="description">mask for excluding the sign bit of a single-precision floating-point number.</span>
149+
142150
</section>
143151

144152
<!-- /.related -->
@@ -149,6 +157,16 @@ Macro for the mask for the significand of a [single-precision floating-point num
149157

150158
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
151159

160+
<!-- <related-links> -->
161+
162+
[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask
163+
164+
[@stdlib/constants/float32/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sign-mask
165+
166+
[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask
167+
168+
<!-- </related-links> -->
169+
152170
</section>
153171

154172
<!-- /.links -->

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

+17
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,15 @@ int main( void ) {
177177

178178
<section class="related">
179179

180+
* * *
181+
182+
## See Also
183+
184+
- <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>
185+
- <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>
186+
- <span class="package-name">[`@stdlib/math/base/special/asind`][@stdlib/math/base/special/asind]</span><span class="delimiter">: </span><span class="description">compute the arcsine (in degrees) of a double-precision floating-point number.</span>
187+
- <span class="package-name">[`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]</span><span class="delimiter">: </span><span class="description">compute the arctangent(in degrees) of a double-precision floating-point number.</span>
188+
180189
</section>
181190

182191
<!-- /.related -->
@@ -189,6 +198,14 @@ int main( void ) {
189198

190199
<!-- <related-links> -->
191200

201+
[@stdlib/math/base/special/acos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acos
202+
203+
[@stdlib/math/base/special/acosh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosh
204+
205+
[@stdlib/math/base/special/asind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asind
206+
207+
[@stdlib/math/base/special/atand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atand
208+
192209
<!-- </related-links> -->
193210

194211
</section>

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

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

191191
<section class="related">
192192

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

195202
<!-- /.related -->
@@ -202,6 +209,10 @@ int main( void ) {
202209

203210
<!-- <related-links> -->
204211

212+
[@stdlib/math/base/special/rcbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/rcbrt
213+
214+
[@stdlib/math/base/special/cbrtf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrtf
215+
205216
<!-- </related-links> -->
206217

207218
</section>

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

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

248260
<!-- /.links -->

lib/node_modules/@stdlib/slice/base/normalize-slice/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
136136

137137
<section class="related">
138138

139+
* * *
140+
141+
## See Also
142+
143+
- <span class="package-name">[`@stdlib/slice/base/normalize-multi-slice`][@stdlib/slice/base/normalize-multi-slice]</span><span class="delimiter">: </span><span class="description">normalize a MultiSlice object.</span>
144+
139145
</section>
140146

141147
<!-- /.related -->
@@ -146,6 +152,12 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
146152

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

155+
<!-- <related-links> -->
156+
157+
[@stdlib/slice/base/normalize-multi-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/normalize-multi-slice
158+
159+
<!-- </related-links> -->
160+
149161
</section>
150162

151163
<!-- /.links -->

lib/node_modules/@stdlib/strided/base/dtype-str2enum/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@ v = str2enum( 'uint8' );
124124

125125
<section class="related">
126126

127+
* * *
128+
129+
## See Also
130+
131+
- <span class="package-name">[`@stdlib/strided/base/dtype-enum2str`][@stdlib/strided/base/dtype-enum2str]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a strided array data type enumeration constant.</span>
132+
127133
</section>
128134

129135
<!-- /.related -->
@@ -132,6 +138,12 @@ v = str2enum( 'uint8' );
132138

133139
<section class="links">
134140

141+
<!-- <related-links> -->
142+
143+
[@stdlib/strided/base/dtype-enum2str]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/dtype-enum2str
144+
145+
<!-- </related-links> -->
146+
135147
</section>
136148

137149
<!-- /.links -->

lib/node_modules/@stdlib/utils/async/function-sequence/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,6 @@ f( 5, 3, done );
213213

214214
<!-- <related-links> -->
215215

216-
[@stdlib/utils/async/compose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/async/compose
217-
218216
[@stdlib/utils/function-sequence]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/function-sequence
219217

220218
<!-- </related-links> -->

0 commit comments

Comments
 (0)