Skip to content

docs: update related packages sections #4135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/array/take/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ console.log( y );

## See Also

- <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>
- <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>

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

<!-- <related-links> -->

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

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

<!-- </related-links> -->
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/assert/is-negative-finite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@ bool = isNegativeFinite( new Number( -1.0/0.0 ) );

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>

</section>

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

<section class="links">

<!-- <related-links> -->

[@stdlib/assert/is-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-finite

[@stdlib/assert/is-negative-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-negative-number

[@stdlib/assert/is-positive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-positive-finite

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

</section>

<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log10/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ int main() {

- <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>
- <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>
- <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>
- <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>

</section>

Expand Down
17 changes: 17 additions & 0 deletions lib/node_modules/@stdlib/ndarray/filter-map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,15 @@ console.log( ndarray2array( y ) );

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>
- <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>

</section>

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

<!-- <related-links> -->

[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter

[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map

[@stdlib/ndarray/reject]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reject

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

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,6 @@ for ( i = 0; i < 10; i++ ) {

<!-- /.examples -->


<!-- C interface documentation. -->

* * *
Expand Down Expand Up @@ -240,10 +239,8 @@ int main( void ) {

</section>


<!-- /.c -->


<!-- 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. -->

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

<!-- /.references -->


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

<section class="related">
Expand Down
Loading