Skip to content

Commit cf7d38a

Browse files
authored
docs: update related packages sections
PR-URL: #3527 Reviewed-by: Athan Reines <[email protected]>
1 parent 6559e70 commit cf7d38a

File tree

7 files changed

+70
-5
lines changed

7 files changed

+70
-5
lines changed

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
<!--
32
43
@license Apache-2.0

Diff for: lib/node_modules/@stdlib/array/base/one-to/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,13 @@ console.log( y );
116116

117117
<section class="related">
118118

119+
* * *
120+
121+
## See Also
122+
123+
- <span class="package-name">[`@stdlib/array/base/zero-to`][@stdlib/array/base/zero-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by 1 starting from zero.</span>
124+
- <span class="package-name">[`@stdlib/array/base/ones`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a generic array filled with ones.</span>
125+
119126
</section>
120127

121128
<!-- /.related -->
@@ -124,6 +131,14 @@ console.log( y );
124131

125132
<section class="links">
126133

134+
<!-- <related-links> -->
135+
136+
[@stdlib/array/base/zero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zero-to
137+
138+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
139+
140+
<!-- </related-links> -->
141+
127142
</section>
128143

129144
<!-- /.links -->

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

+27
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,17 @@ out = zeros5d( [ 1, 1, 1, 3, 1 ] );
9595

9696
<section class="related">
9797

98+
* * *
99+
100+
## See Also
101+
102+
- <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>
103+
- <span class="package-name">[`@stdlib/array/base/ones5d`][@stdlib/array/base/ones5d]</span><span class="delimiter">: </span><span class="description">create a five-dimensional nested array filled with ones.</span>
104+
- <span class="package-name">[`@stdlib/array/base/zeros2d`][@stdlib/array/base/zeros2d]</span><span class="delimiter">: </span><span class="description">create a zero-filled two-dimensional nested array.</span>
105+
- <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>
106+
- <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>
107+
- <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>
108+
98109
</section>
99110

100111
<!-- /.related -->
@@ -103,6 +114,22 @@ out = zeros5d( [ 1, 1, 1, 3, 1 ] );
103114

104115
<section class="links">
105116

117+
<!-- <related-links> -->
118+
119+
[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
120+
121+
[@stdlib/array/base/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d
122+
123+
[@stdlib/array/base/zeros2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros2d
124+
125+
[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d
126+
127+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
128+
129+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
130+
131+
<!-- </related-links> -->
132+
106133
</section>
107134

108135
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn2/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,10 @@ console.log( v );
175175

176176
## See Also
177177

178-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.</span>
179-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
178+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]</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 using a second-order iterative Kahan–Babuška algorithm.</span>
179+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
180180
- <span class="package-name">[`@stdlib/blas/ext/base/gsumkbn2`][@stdlib/blas/ext/base/gsumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>
181-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn2`][@stdlib/blas/ext/base/sapxsumkbn2]</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 a second-order iterative Kahan–Babuška algorithm.</span>
181+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn2`][@stdlib/blas/ext/base/sapxsumkbn2]</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 a second-order iterative Kahan–Babuška algorithm.</span>
182182

183183
</section>
184184

Diff for: lib/node_modules/@stdlib/ndarray/iter/interleave-subarrays/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,13 @@ while ( true ) {
146146

147147
<section class="related">
148148

149+
* * *
150+
151+
## See Also
152+
153+
- <span class="package-name">[`@stdlib/ndarray/iter/subarrays`][@stdlib/ndarray/iter/subarrays]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each subarray in a stack of subarrays.</span>
154+
- <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>
155+
149156
</section>
150157

151158
<!-- /.related -->
@@ -162,6 +169,10 @@ while ( true ) {
162169

163170
<!-- <related-links> -->
164171

172+
[@stdlib/ndarray/iter/subarrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/subarrays
173+
174+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
175+
165176
<!-- </related-links> -->
166177

167178
</section>

Diff for: lib/node_modules/@stdlib/random/strided/weibull/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,13 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
207207

208208
<section class="related">
209209

210+
* * *
211+
212+
## See Also
213+
214+
- <span class="package-name">[`@stdlib/random/base/weibull`][@stdlib/random/base/weibull]</span><span class="delimiter">: </span><span class="description">Weibull distributed pseudorandom numbers.</span>
215+
- <span class="package-name">[`@stdlib/random/array/weibull`][@stdlib/random/array/weibull]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a Weibull distribution.</span>
216+
210217
</section>
211218

212219
<!-- /.related -->
@@ -221,6 +228,12 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
221228

222229
[@stdlib/array/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/uint32
223230

231+
<!-- <related-links> -->
232+
233+
[@stdlib/random/array/weibull]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/weibull
234+
235+
<!-- </related-links> -->
236+
224237
</section>
225238

226239
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/stats/bartlett-test/README.md

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

210210
## See Also
211211

212-
- <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>
212+
- <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>
213213
- <span class="package-name">[`@stdlib/stats/levene-test`][@stdlib/stats/levene-test]</span><span class="delimiter">: </span><span class="description">Levene's test for equal variances.</span>
214214

215215
</section>

0 commit comments

Comments
 (0)