Skip to content

Commit 5b71452

Browse files
stdlib-botkgryte
andauthored
docs: update related packages sections
PR-URL: #4135 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 6becb40 commit 5b71452

File tree

5 files changed

+39
-5
lines changed

5 files changed

+39
-5
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ console.log( y );
130130

131131
## See Also
132132

133+
- <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>
133134
- <span class="package-name">[`@stdlib/array/slice`][@stdlib/array/slice]</span><span class="delimiter">: </span><span class="description">return a shallow copy of a portion of an array.</span>
134135

135136
</section>
@@ -146,6 +147,8 @@ console.log( y );
146147

147148
<!-- <related-links> -->
148149

150+
[@stdlib/array/put]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/put
151+
149152
[@stdlib/array/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/slice
150153

151154
<!-- </related-links> -->

lib/node_modules/@stdlib/assert/is-negative-finite/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ bool = isNegativeFinite( new Number( -1.0/0.0 ) );
142142

143143
<section class="related">
144144

145+
* * *
146+
147+
## See Also
148+
149+
- <span class="package-name">[`@stdlib/assert/is-finite`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span>
150+
- <span class="package-name">[`@stdlib/assert/is-negative-number`][@stdlib/assert/is-negative-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a negative value.</span>
151+
- <span class="package-name">[`@stdlib/assert/is-positive-finite`][@stdlib/assert/is-positive-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a finite positive value.</span>
152+
145153
</section>
146154

147155
<!-- /.related -->
@@ -150,6 +158,16 @@ bool = isNegativeFinite( new Number( -1.0/0.0 ) );
150158

151159
<section class="links">
152160

161+
<!-- <related-links> -->
162+
163+
[@stdlib/assert/is-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-finite
164+
165+
[@stdlib/assert/is-negative-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-negative-number
166+
167+
[@stdlib/assert/is-positive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-positive-finite
168+
169+
<!-- </related-links> -->
170+
153171
</section>
154172

155173
<!-- /.links -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ int main() {
207207

208208
- <span class="package-name">[`@stdlib/math/base/special/exp10`][@stdlib/math/base/special/exp10]</span><span class="delimiter">: </span><span class="description">base 10 exponential function.</span>
209209
- <span class="package-name">[`@stdlib/math/base/special/ln`][@stdlib/math/base/special/ln]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of a double-precision floating-point number.</span>
210-
- <span class="package-name">[`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">base `b` logarithm.</span>
210+
- <span class="package-name">[`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">compute the base `b` logarithm of a double-precision floating-point number.</span>
211211

212212
</section>
213213

lib/node_modules/@stdlib/ndarray/filter-map/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,15 @@ console.log( ndarray2array( y ) );
246246

247247
<section class="related">
248248

249+
* * *
250+
251+
## See Also
252+
253+
- <span class="package-name">[`@stdlib/ndarray/filter`][@stdlib/ndarray/filter]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
254+
- <span class="package-name">[`@stdlib/ndarray/map`][@stdlib/ndarray/map]</span><span class="delimiter">: </span><span class="description">apply a callback to elements in an input ndarray and assign results to elements in a new output ndarray.</span>
255+
- <span class="package-name">[`@stdlib/ndarray/reject`][@stdlib/ndarray/reject]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which fail a test implemented by a predicate function.</span>
256+
- <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>
257+
249258
</section>
250259

251260
<!-- /.related -->
@@ -260,6 +269,14 @@ console.log( ndarray2array( y ) );
260269

261270
<!-- <related-links> -->
262271

272+
[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter
273+
274+
[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map
275+
276+
[@stdlib/ndarray/reject]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reject
277+
278+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
279+
263280
<!-- </related-links> -->
264281

265282
</section>

lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/median/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ for ( i = 0; i < 10; i++ ) {
143143

144144
<!-- /.examples -->
145145

146-
147146
<!-- C interface documentation. -->
148147

149148
* * *
@@ -240,10 +239,8 @@ int main( void ) {
240239

241240
</section>
242241

243-
244242
<!-- /.c -->
245243

246-
247244
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
248245

249246
<section class="references">
@@ -252,7 +249,6 @@ int main( void ) {
252249

253250
<!-- /.references -->
254251

255-
256252
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
257253

258254
<section class="related">

0 commit comments

Comments
 (0)