Skip to content

docs: update related packages sections #2248

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 1 commit into from
May 18, 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
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/flatten-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/flatten`][@stdlib/array/base/flatten]</span><span class="delimiter">: </span><span class="description">flatten an n-dimensional nested array.</span>

</section>

<!-- /.related -->
Expand All @@ -208,6 +214,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );

<section class="links">

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

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

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/flatten3d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/flatten3d-by`][@stdlib/array/base/flatten3d-by]</span><span class="delimiter">: </span><span class="description">flatten a three-dimensional nested array according to a callback function.</span>

</section>

<!-- /.related -->
Expand All @@ -147,6 +153,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );

<section class="links">

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/base/fliplr2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/fliplr3d`][@stdlib/array/base/fliplr3d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a three-dimensional nested input array.</span>
- <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>
- <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>

</section>

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

<section class="links">

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

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

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

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

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

</section>

<!-- /.links -->
27 changes: 27 additions & 0 deletions lib/node_modules/@stdlib/array/base/onesnd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,17 @@ out = onesnd( [ 1, 1, 1, 3 ] );

<section class="related">

* * *

## See Also

- <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>
- <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>
- <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>
- <span class="package-name">[`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]</span><span class="delimiter">: </span><span class="description">create a three-dimensional nested array filled with ones.</span>
- <span class="package-name">[`@stdlib/array/base/ones4d`][@stdlib/array/base/ones4d]</span><span class="delimiter">: </span><span class="description">create a four-dimensional nested array filled with ones.</span>
- <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>

</section>

<!-- /.related -->
Expand All @@ -112,6 +123,22 @@ out = onesnd( [ 1, 1, 1, 3 ] );

<section class="links">

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
27 changes: 27 additions & 0 deletions lib/node_modules/@stdlib/array/base/zerosnd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,17 @@ out = zerosnd( [ 1, 1, 1, 3 ] );

<section class="related">

* * *

## See Also

- <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>
- <span class="package-name">[`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]</span><span class="delimiter">: </span><span class="description">create an n-dimensional nested array filled with ones.</span>
- <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>
- <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>
- <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>
- <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>

</section>

<!-- /.related -->
Expand All @@ -112,6 +123,22 @@ out = zerosnd( [ 1, 1, 1, 3 ] );

<section class="links">

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/asinf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,13 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asindf`][@stdlib/math/base/special/asindf]</span><span class="delimiter">: </span><span class="description">compute the arcsine (in degrees) of a single-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -170,6 +177,14 @@ int main( void ) {

[arcsine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions

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

[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin

[@stdlib/math/base/special/asindf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asindf

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,13 @@ forEachCodePointRight( '\uD834\uDD1E', log );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/for-each-code-point`][@stdlib/string/base/for-each-code-point]</span><span class="delimiter">: </span><span class="description">invoke a function for each Unicode code point in a string.</span>
- <span class="package-name">[`@stdlib/string/base/for-each-right`][@stdlib/string/base/for-each-right]</span><span class="delimiter">: </span><span class="description">invoke a function for each UTF-16 code unit in a string, iterating from right to left.</span>

</section>

<!-- /.related -->
Expand All @@ -141,6 +148,14 @@ forEachCodePointRight( '\uD834\uDD1E', log );

<section class="links">

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

[@stdlib/string/base/for-each-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-code-point

[@stdlib/string/base/for-each-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-right

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/headercase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ out = headercase( str );

<section class="related">

* * *

## See Also

- <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>
- <span class="package-name">[`@stdlib/string/base/pascalcase`][@stdlib/string/base/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
- <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>

</section>

<!-- /.related -->
Expand All @@ -92,6 +100,16 @@ out = headercase( str );

<section class="links">

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

[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase

[@stdlib/string/base/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/pascalcase

[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase

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

</section>

<!-- /.links -->
Loading