Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 8, 2024
1 parent 911e839 commit 04720a4
Show file tree
Hide file tree
Showing 9 changed files with 139 additions and 5 deletions.
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/array/little-endian-float64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,14 @@ logEach( '%s', out );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/fixed-endian-float64`][@stdlib/array/fixed-endian-float64]</span><span class="delimiter">: </span><span class="description">Float64Array having a specified byte order.</span>
- <span class="package-name">[`@stdlib/array/float64`][@stdlib/array/float64]</span><span class="delimiter">: </span><span class="description">Float64Array.</span>
- <span class="package-name">[`@stdlib/array/little-endian-float32`][@stdlib/array/little-endian-float32]</span><span class="delimiter">: </span><span class="description">Float32Array in little-endian byte order.</span>

</section>

<!-- /.related -->
Expand All @@ -433,6 +441,14 @@ logEach( '%s', out );

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

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

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

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

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

</section>

<!-- /.links -->
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/blas/base/dswap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,15 @@ int main( void ) {
<section class="related">
* * *
## See Also
- <span class="package-name">[`@stdlib/blas/base/dcopy`][@stdlib/blas/base/dcopy]</span><span class="delimiter">: </span><span class="description">copy values from x into y.</span>
- <span class="package-name">[`@stdlib/blas/base/gswap`][@stdlib/blas/base/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
- <span class="package-name">[`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/dswap`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
</section>
<!-- /.related -->
Expand All @@ -320,6 +329,18 @@ int main( void ) {
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
<!-- <related-links> -->
[@stdlib/blas/base/dcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dcopy
[@stdlib/blas/base/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/gswap
[@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap
[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap
<!-- </related-links> -->
</section>
<!-- /.links -->
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/tand/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,13 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/tan`][@stdlib/math/base/special/tan]</span><span class="delimiter">: </span><span class="description">evaluate the tangent of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/cosd`][@stdlib/math/base/special/cosd]</span><span class="delimiter">: </span><span class="description">compute the cosine of an angle measured in degrees.</span>

</section>

<!-- /.related -->
Expand All @@ -182,6 +189,10 @@ int main( void ) {

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

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

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

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

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

<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 @@ -84,6 +91,14 @@ str = capitalize( 'Hidden Treasures' );

<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 -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/string/base/format-interpolate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ out = formatInterpolate( tokens, 0, 'foo' );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/format-tokenize`][@stdlib/string/base/format-tokenize]</span><span class="delimiter">: </span><span class="description">tokenize a string into an array of string parts and format identifier objects.</span>

</section>

<!-- /.related -->
Expand All @@ -111,6 +117,12 @@ out = formatInterpolate( tokens, 0, 'foo' );

<section class="links">

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

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

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/string/base/last/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ str = last( 'good night', 5 );

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/first`][@stdlib/string/base/first]</span><span class="delimiter">: </span><span class="description">return the first UTF-16 code unit of a string.</span>
- <span class="package-name">[`@stdlib/string/base/last-code-point`][@stdlib/string/base/last-code-point]</span><span class="delimiter">: </span><span class="description">return the last Unicode code point of a string.</span>
- <span class="package-name">[`@stdlib/string/base/last-grapheme-cluster`][@stdlib/string/base/last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the last grapheme cluster (i.e., user-perceived character) of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -91,6 +97,12 @@ str = last( 'good night', 5 );

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

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

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

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

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

</section>
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/pascalcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ out = pascalcase( 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/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 = pascalcase( 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/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/string/base/remove-last/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ str = removeLast( 'The Last of the Mohicans', 5 );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/remove-last-code-point`][@stdlib/string/base/remove-last-code-point]</span><span class="delimiter">: </span><span class="description">remove the last Unicode code point of a string.</span>
- <span class="package-name">[`@stdlib/string/base/remove-last-grapheme-cluster`][@stdlib/string/base/remove-last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the last grapheme cluster (i.e., user-perceived character) of a string.</span>
- <span class="package-name">[`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first UTF-16 code unit of a string.</span>

</section>

<!-- /.related -->
Expand All @@ -87,6 +95,16 @@ str = removeLast( 'The Last of the Mohicans', 5 );

<section class="links">

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

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

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

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

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

</section>

<!-- /.links -->
21 changes: 16 additions & 5 deletions lib/node_modules/@stdlib/utils/some-in-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,11 +202,10 @@ bool = someInBy( obj, 5, threshold );

## See Also

- <span class="package-name">[`@stdlib/utils/any-by`][@stdlib/utils/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/every-by`][@stdlib/utils/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</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/async/some-by`][@stdlib/utils/async/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains `n` elements which pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-by-right`][@stdlib/utils/some-by-right]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.</span>
- <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/some-by`][@stdlib/utils/some-by]</span><span class="delimiter">: </span><span class="description">test whether a collection contains at least `n` elements which pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>

</section>

Expand All @@ -229,6 +228,18 @@ bool = someInBy( obj, 5, threshold );

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

<!-- <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/some-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-by

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

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

</section>

<!-- /.links -->

0 comments on commit 04720a4

Please sign in to comment.