Skip to content

Commit ac06419

Browse files
authoredDec 10, 2024
docs: update related packages sections
PR-URL: #3387 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 1c56b73 commit ac06419

File tree

12 files changed

+161
-5
lines changed

12 files changed

+161
-5
lines changed
 

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

+12
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,12 @@ out = flatten2d( x, [ 4, 4 ], true );
139139

140140
<section class="related">
141141

142+
* * *
143+
144+
## See Also
145+
146+
- <span class="package-name">[`@stdlib/array/base/flatten2d-by`][@stdlib/array/base/flatten2d-by]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array according to a callback function.</span>
147+
142148
</section>
143149

144150
<!-- /.related -->
@@ -147,6 +153,12 @@ out = flatten2d( x, [ 4, 4 ], true );
147153

148154
<section class="links">
149155

156+
<!-- <related-links> -->
157+
158+
[@stdlib/array/base/flatten2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d-by
159+
160+
<!-- </related-links> -->
161+
150162
</section>
151163

152164
<!-- /.links -->

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

+12
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,12 @@ out = flatten3dBy( x, [ 4, 2, 2 ], true, fcn );
185185

186186
<section class="related">
187187

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

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

194200
<section class="links">
195201

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

198210
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/fliplr3d/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ console.log( y );
9797

9898
<section class="related">
9999

100+
* * *
101+
102+
## See Also
103+
104+
- <span class="package-name">[`@stdlib/array/base/fliplr2d`][@stdlib/array/base/fliplr2d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a two-dimensional nested input array.</span>
105+
- <span class="package-name">[`@stdlib/array/base/fliplr4d`][@stdlib/array/base/fliplr4d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a four-dimensional nested input array.</span>
106+
- <span class="package-name">[`@stdlib/array/base/fliplr5d`][@stdlib/array/base/fliplr5d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a five-dimensional nested input array.</span>
107+
100108
</section>
101109

102110
<!-- /.related -->
@@ -105,6 +113,16 @@ console.log( y );
105113

106114
<section class="links">
107115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/array/base/fliplr2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr2d
119+
120+
[@stdlib/array/base/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d
121+
122+
[@stdlib/array/base/fliplr5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr5d
123+
124+
<!-- </related-links> -->
125+
108126
</section>
109127

110128
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/zeros2d/README.md

+27
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ console.log( arr );
103103

104104
<section class="related">
105105

106+
* * *
107+
108+
## See Also
109+
110+
- <span class="package-name">[`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled generic array.</span>
111+
- <span class="package-name">[`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]</span><span class="delimiter">: </span><span class="description">create a two-dimensional nested array filled with ones.</span>
112+
- <span class="package-name">[`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]</span><span class="delimiter">: </span><span class="description">create a zero-filled three-dimensional nested array.</span>
113+
- <span class="package-name">[`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]</span><span class="delimiter">: </span><span class="description">create a zero-filled four-dimensional nested array.</span>
114+
- <span class="package-name">[`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]</span><span class="delimiter">: </span><span class="description">create a zero-filled five-dimensional nested array.</span>
115+
- <span class="package-name">[`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]</span><span class="delimiter">: </span><span class="description">create a zero-filled n-dimensional nested array.</span>
116+
106117
</section>
107118

108119
<!-- /.related -->
@@ -111,6 +122,22 @@ console.log( arr );
111122

112123
<section class="links">
113124

125+
<!-- <related-links> -->
126+
127+
[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
128+
129+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
130+
131+
[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d
132+
133+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
134+
135+
[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d
136+
137+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
138+
139+
<!-- </related-links> -->
140+
114141
</section>
115142

116143
<!-- /.links -->

‎lib/node_modules/@stdlib/array/place/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/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>
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/mskput]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/mskput
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/assert/has-btoa-support/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ $ has-btoa-support
108108

109109
<section class="related">
110110

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

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

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

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

123135
<!-- /.links -->

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ int main( void ) {
301301
302302
## See Also
303303
304-
- <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>
304+
- <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>
305305
- <span class="package-name">[`@stdlib/blas/base/gasum`][@stdlib/blas/base/gasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm).</span>
306306
- <span class="package-name">[`@stdlib/blas/base/sasum`][@stdlib/blas/base/sasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm).</span>
307307
- <span class="package-name">[`@stdlib/blas/ext/base/dsum`][@stdlib/blas/ext/base/dsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements.</span>

‎lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,10 @@ int main( void ) {
283283
284284
## See Also
285285
286-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum.</span>
286+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum.</span>
287287
- <span class="package-name">[`@stdlib/blas/ext/base/dsumkbn`][@stdlib/blas/ext/base/dsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
288-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
289-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
288+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
289+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
290290
291291
</section>
292292

‎lib/node_modules/@stdlib/iter/do-while-each/README.md

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

227227
<section class="related">
228228

229+
* * *
230+
231+
## See Also
232+
233+
- <span class="package-name">[`@stdlib/iter/do-until-each`][@stdlib/iter/do-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>
234+
- <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>
235+
- <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>
236+
229237
</section>
230238

231239
<!-- /.related -->
@@ -234,6 +242,16 @@ while ( true ) {
234242

235243
<section class="links">
236244

245+
<!-- <related-links> -->
246+
247+
[@stdlib/iter/do-until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-until-each
248+
249+
[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each
250+
251+
[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each
252+
253+
<!-- </related-links> -->
254+
237255
</section>
238256

239257
<!-- /.links -->

‎lib/node_modules/@stdlib/slice/base/nonreduced-dimensions/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,14 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) );
123123

124124
<section class="related">
125125

126+
* * *
127+
128+
## See Also
129+
130+
- <span class="package-name">[`@stdlib/slice/base/length`][@stdlib/slice/base/length]</span><span class="delimiter">: </span><span class="description">compute the number of elements in a normalized slice.</span>
131+
- <span class="package-name">[`@stdlib/slice/base/reduced-dimensions`][@stdlib/slice/base/reduced-dimensions]</span><span class="delimiter">: </span><span class="description">return a list of reduced dimensions in an un-normalized multi-slice.</span>
132+
- <span class="package-name">[`@stdlib/slice/base/shape`][@stdlib/slice/base/shape]</span><span class="delimiter">: </span><span class="description">compute the shape of a normalized multi-slice.</span>
133+
126134
</section>
127135

128136
<!-- /.related -->
@@ -133,6 +141,16 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) );
133141

134142
[@stdlib/slice/multi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/multi
135143

144+
<!-- <related-links> -->
145+
146+
[@stdlib/slice/base/length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/length
147+
148+
[@stdlib/slice/base/reduced-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/reduced-dimensions
149+
150+
[@stdlib/slice/base/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/shape
151+
152+
<!-- </related-links> -->
153+
136154
</section>
137155

138156
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/levene-test/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ var table = out.print();
197197

198198
## See Also
199199

200-
- <span class="package-name">[`@stdlib/stats/vartest`][@stdlib/stats/vartest]</span><span class="delimiter">: </span><span class="description">two-sample F-test for equal variances</span>
200+
- <span class="package-name">[`@stdlib/stats/vartest`][@stdlib/stats/vartest]</span><span class="delimiter">: </span><span class="description">two-sample F-test for equal variances.</span>
201201
- <span class="package-name">[`@stdlib/stats/bartlett-test`][@stdlib/stats/bartlett-test]</span><span class="delimiter">: </span><span class="description">Bartlett’s test for equal variances.</span>
202202

203203
</section>

‎lib/node_modules/@stdlib/string/base/dotcase/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,15 @@ out = dotcase( 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 = dotcase( 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 -->

0 commit comments

Comments
 (0)