Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history 
PR-URL: #4362
Reviewed-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
  • Loading branch information
@stdlib-bot
stdlib-bot authored Dec 30, 2024
1 parent cdf5e79 commit 4301694
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 1 deletion.
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/min-base10-exponent/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,13 @@ Macro for the minimum base 10 exponent for a normal [single-precision floating-p

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/min-base10-exponent-subnormal`][@stdlib/constants/float32/min-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a subnormal single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float64/min-base10-exponent`][@stdlib/constants/float64/min-base10-exponent]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a normal double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -138,6 +145,10 @@ Macro for the minimum base 10 exponent for a normal [single-precision floating-p

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

[@stdlib/constants/float32/min-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent-subnormal

[@stdlib/constants/float64/min-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-base10-exponent

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

</section>
Expand Down
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ Macro for the minimum biased base 2 exponent for a subnormal [single-precision f

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/min-base2-exponent`][@stdlib/constants/float32/min-base2-exponent]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a normal single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float64/min-base2-exponent-subnormal`][@stdlib/constants/float64/min-base2-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a subnormal double-precision floating-point number.</span>

</section>

<!-- /.related -->
Expand All @@ -136,6 +143,10 @@ Macro for the minimum biased base 2 exponent for a subnormal [single-precision f

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

[@stdlib/constants/float32/min-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base2-exponent

[@stdlib/constants/float64/min-base2-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-base2-exponent-subnormal

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

</section>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/log2/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ int main( void ) {

- <span class="package-name">[`@stdlib/math/base/special/exp2`][@stdlib/math/base/special/exp2]</span><span class="delimiter">: </span><span class="description">base 2 exponential function.</span>
- <span class="package-name">[`@stdlib/math/base/special/ln`][@stdlib/math/base/special/ln]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">base `b` logarithm.</span>
- <span class="package-name">[`@stdlib/math/base/special/log`][@stdlib/math/base/special/log]</span><span class="delimiter">: </span><span class="description">compute the base `b` logarithm of a double-precision floating-point number.</span>

</section>

Expand Down
11 changes: 11 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/secd/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,13 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <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>
- <span class="package-name">[`@stdlib/math/base/special/cos`][@stdlib/math/base/special/cos]</span><span class="delimiter">: </span><span class="description">compute the cosine of a number.</span>

</section>

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

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

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

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

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

</section>
Expand Down
8 changes: 8 additions & 0 deletions lib/node_modules/@stdlib/ndarray/for-each/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,12 @@ forEach( x, naryFunction( log, 2 ) );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/ndarray/map`][@stdlib/ndarray/map]</span><span class="delimiter">: </span><span class="description">apply a callback to elements in an input ndarray and assign results to elements in a new output ndarray.</span>

</section>

<!-- /.related -->
Expand All @@ -157,6 +163,8 @@ forEach( x, naryFunction( log, 2 ) );

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

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

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

</section>
Expand Down

1 comment on commit 4301694

@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
constants/float32/min-base10-exponent $\color{green}48/48$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}48/48$
$\color{green}+100.00\%$
constants/float32/min-base2-exponent-subnormal $\color{green}54/54$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}54/54$
$\color{green}+100.00\%$
math/base/special/log2 $\color{green}290/290$
$\color{green}+100.00\%$ 		$\color{green}16/16$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}290/290$
$\color{green}+100.00\%$
math/base/special/secd $\color{green}188/188$
$\color{green}+100.00\%$ 		$\color{green}5/5$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}188/188$
$\color{green}+100.00\%$
ndarray/for-each $\color{green}123/123$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}123/123$
$\color{green}+100.00\%$

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

Please # to comment.