Skip to content

docs: update related packages sections #4334

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
Dec 29, 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
1 change: 0 additions & 1 deletion lib/node_modules/@stdlib/array/base/cuany-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,6 @@ console.log( out );

<section class="links">


</section>

<!-- /.links -->
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/blas/base/gaxpy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ console.log( y );

## See Also

- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>

</section>

Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/nlp/sentencize/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@ bool = ( out[ 0 ] === sentences[ 0 ] );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/nlp/tokenize`][@stdlib/nlp/tokenize]</span><span class="delimiter">: </span><span class="description">tokenize a string.</span>

</section>

<!-- /.related -->
Expand All @@ -98,6 +104,12 @@ bool = ( out[ 0 ] === sentences[ 0 ] );

<section class="links">

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/slice/base/length/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ console.log( '[ %s ]', incrspace( s2.start, s2.stop || -1, s2.step ).join( ', '

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/slice/base/nonreduced-dimensions`][@stdlib/slice/base/nonreduced-dimensions]</span><span class="delimiter">: </span><span class="description">return a list of non-reduced dimensions in an un-normalized multi-slice.</span>
- <span class="package-name">[`@stdlib/slice/base/reduced-dimensions`][@stdlib/slice/base/reduced-dimensions]</span><span class="delimiter">: </span><span class="description">return a list of reduced dimensions in an un-normalized multi-slice.</span>
- <span class="package-name">[`@stdlib/slice/base/shape`][@stdlib/slice/base/shape]</span><span class="delimiter">: </span><span class="description">compute the shape of a normalized multi-slice.</span>

</section>

<!-- /.related -->
Expand All @@ -166,6 +174,16 @@ console.log( '[ %s ]', incrspace( s2.start, s2.stop || -1, s2.step ).join( ', '

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

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

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

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

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

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

</section>

<!-- /.links -->
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/string/base/stickycase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ out = stickycase( 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 @@ -105,6 +114,18 @@ out = stickycase( 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 -->
Loading