Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
PR-URL: #4594

Reviewed-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
stdlib-bot authored Jan 6, 2025
1 parent bfa8cf1 commit 563a4f8
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 1 deletion.
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/filled3d-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ out = filled3dBy( [ 1, 1, 3 ], constantFunction( void 0 ) );

<section class="related">

* * *

## See Also

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

</section>

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

<section class="links">

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

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

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

</section>

<!-- /.links -->
8 changes: 8 additions & 0 deletions lib/node_modules/@stdlib/assert/is-pascalcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ true

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

</section>

<!-- /.related -->
Expand All @@ -180,6 +186,8 @@ true

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

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

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ int main( void ) {
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dsumkbn`][@stdlib/blas/ext/base/dsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,12 @@ Macro for one half times the [natural logarithm][@stdlib/math/base/special/ln] o

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float64/half-ln-two`][@stdlib/constants/float64/half-ln-two]</span><span class="delimiter">: </span><span class="description">one half times the natural logarithm of 2.</span>

</section>

<!-- /.related -->
Expand All @@ -132,6 +138,8 @@ Macro for one half times the [natural logarithm][@stdlib/math/base/special/ln] o

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

[@stdlib/constants/float64/half-ln-two]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/half-ln-two

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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/string/base/right-pad/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ logEach( '%s', out );

<section class="related">

* * *

## See Also

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

</section>

<!-- /.related -->
Expand All @@ -117,6 +123,12 @@ logEach( '%s', out );

<section class="links">

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

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

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

</section>

<!-- /.links -->

1 comment on commit 563a4f8

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base/filled3d-by $\color{green}112/112$
$\color{green}+100.00\%$
$\color{green}5/5$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}112/112$
$\color{green}+100.00\%$
assert/is-pascalcase $\color{green}101/101$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}101/101$
$\color{green}+100.00\%$
blas/ext/base/dapxsumkbn $\color{green}392/392$
$\color{green}+100.00\%$
$\color{green}21/21$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}392/392$
$\color{green}+100.00\%$
constants/float32/half-ln-two $\color{green}50/50$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}50/50$
$\color{green}+100.00\%$
string/base/right-pad $\color{green}107/107$
$\color{green}+100.00\%$
$\color{green}5/5$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}107/107$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.