Skip to content

docs: update related packages sections #4009

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 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/filled5d-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/filled5d`][@stdlib/array/base/filled5d]</span><span class="delimiter">: </span><span class="description">create a filled five-dimensional nested array.</span>

</section>

<!-- /.related -->
Expand All @@ -142,6 +148,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );

<section class="links">

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

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

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

</section>

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

<section class="related">

* * *

## See Also

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

</section>

<!-- /.related -->
Expand All @@ -162,6 +168,12 @@ out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );

<section class="links">

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

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

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

</section>

<!-- /.links -->
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/assert/is-camelcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,13 @@ false

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
- <span class="package-name">[`@stdlib/assert/is-constantcase`][@stdlib/assert/is-constantcase]</span><span class="delimiter">: </span><span class="description">test if a value is a constant-case string.</span>

</section>

<!-- /.related -->
Expand All @@ -183,6 +190,10 @@ false

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

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

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

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

</section>
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/iter/do-until-each/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,14 @@ while ( true ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/iter/do-while-each`][@stdlib/iter/do-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>
- <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>
- <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>

</section>

<!-- /.related -->
Expand All @@ -231,6 +239,16 @@ while ( true ) {

<section class="links">

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

[@stdlib/iter/do-while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-while-each

[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each

[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/math/strided/special/asinh-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,12 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/strided/special/asin-by`][@stdlib/math/strided/special/asin-by]</span><span class="delimiter">: </span><span class="description">compute the arcsine of each element retrieved from an input strided array via a callback function.</span>

</section>

<!-- /.related -->
Expand All @@ -243,6 +249,12 @@ console.log( y );

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

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

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

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

</section>

<!-- /.links -->
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/ndarray/map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,14 @@ 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/filter-map`][@stdlib/ndarray/filter-map]</span><span class="delimiter">: </span><span class="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback 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 @@ -247,6 +255,12 @@ 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/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map

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

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

</section>
Expand Down
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/string/base/altcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ out = altcase( str );

<section class="related">

* * *

## See Also

- <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>
- <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 @@ -97,6 +104,14 @@ out = altcase( str );

<section class="links">

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

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

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

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

</section>

<!-- /.links -->
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/string/base/constantcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ out = constantcase( 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/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
- <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>
- <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 @@ -97,6 +106,18 @@ out = constantcase( 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/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase

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

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

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

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/string/base/trim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ out = trim( '\n\n\nNew Lines\n\n\n' );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/left-trim`][@stdlib/string/base/left-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning of a string.</span>
- <span class="package-name">[`@stdlib/string/base/right-trim`][@stdlib/string/base/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -106,6 +113,14 @@ out = trim( '\n\n\nNew Lines\n\n\n' );

[unicode]: https://en.wikipedia.org/wiki/Unicode

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

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

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

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

</section>

<!-- /.links -->
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/utils/none-in-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@ var bool = noneInBy( obj, isUnderage );

## See Also

- <span class="package-name">[`@stdlib/utils/any-in-by`][@stdlib/utils/any-in-by]</span><span class="delimiter">: </span><span class="description">test whether at least one property in an object passes a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/every-in-by`][@stdlib/utils/every-in-by]</span><span class="delimiter">: </span><span class="description">test whether all properties (own and inherited) of an object pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/for-in`][@stdlib/utils/for-in]</span><span class="delimiter">: </span><span class="description">invoke a function for each own and inherited enumerable property of an object.</span>
- <span class="package-name">[`@stdlib/utils/none-by`][@stdlib/utils/none-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection fail a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-in-by`][@stdlib/utils/some-in-by]</span><span class="delimiter">: </span><span class="description">test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.</span>

</section>

<!-- /.related -->
Expand All @@ -221,6 +227,16 @@ var bool = noneInBy( obj, isUnderage );

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

[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by

[@stdlib/utils/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-in-by

[@stdlib/utils/for-in]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/for-in

[@stdlib/utils/none-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-by

[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by

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

</section>
Expand Down
Loading