Skip to content

Commit 14706e4

Browse files
authored
docs: update related packages sections
PR-URL: #4445 Reviewed-by: Athan Reines <[email protected]>
1 parent 5e56526 commit 14706e4

File tree

5 files changed

+59
-0
lines changed

5 files changed

+59
-0
lines changed

lib/node_modules/@stdlib/constants/float32/fourth-pi/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ Macro for one fourth times the mathematical constant [π][pi].
108108

109109
<section class="related">
110110

111+
* * *
112+
113+
## See Also
114+
115+
- <span class="package-name">[`@stdlib/constants/float32/half-pi`][@stdlib/constants/float32/half-pi]</span><span class="delimiter">: </span><span class="description">1/2 times π.</span>
116+
- <span class="package-name">[`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">π.</span>
117+
- <span class="package-name">[`@stdlib/constants/float32/two-pi`][@stdlib/constants/float32/two-pi]</span><span class="delimiter">: </span><span class="description">2π.</span>
118+
111119
</section>
112120

113121
<!-- /.related -->
@@ -118,6 +126,16 @@ Macro for one fourth times the mathematical constant [π][pi].
118126

119127
[pi]: https://en.wikipedia.org/wiki/Pi
120128

129+
<!-- <related-links> -->
130+
131+
[@stdlib/constants/float32/half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-pi
132+
133+
[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi
134+
135+
[@stdlib/constants/float32/two-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/two-pi
136+
137+
<!-- </related-links> -->
138+
121139
</section>
122140

123141
<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/ln-half/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,12 @@ Macro for the [natural logarithm][@stdlib/math/base/special/lnf] of `1/2` as a s
120120

121121
<section class="related">
122122

123+
* * *
124+
125+
## See Also
126+
127+
- <span class="package-name">[`@stdlib/constants/float64/ln-half`][@stdlib/constants/float64/ln-half]</span><span class="delimiter">: </span><span class="description">natural logarithm of 1/2.</span>
128+
123129
</section>
124130

125131
<!-- /.related -->
@@ -130,6 +136,12 @@ Macro for the [natural logarithm][@stdlib/math/base/special/lnf] of `1/2` as a s
130136

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

139+
<!-- <related-links> -->
140+
141+
[@stdlib/constants/float64/ln-half]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/ln-half
142+
143+
<!-- </related-links> -->
144+
133145
</section>
134146

135147
<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/max-safe-nth-lucas/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,12 @@ Macro for the maximum [safe][safe-integers] nth [Lucas number][lucas-number] whe
151151

152152
<section class="related">
153153

154+
* * *
155+
156+
## See Also
157+
158+
- <span class="package-name">[`@stdlib/constants/float64/max-safe-nth-lucas`][@stdlib/constants/float64/max-safe-nth-lucas]</span><span class="delimiter">: </span><span class="description">maximum safe nth Lucas number when stored in double-precision floating-point format.</span>
159+
154160
</section>
155161

156162
<!-- /.related -->
@@ -167,6 +173,8 @@ Macro for the maximum [safe][safe-integers] nth [Lucas number][lucas-number] whe
167173

168174
<!-- <related-links> -->
169175

176+
[@stdlib/constants/float64/max-safe-nth-lucas]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-safe-nth-lucas
177+
170178
<!-- </related-links> -->
171179

172180
</section>

lib/node_modules/@stdlib/constants/float64/high-word-sign-mask/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,14 @@ Macro for the high word mask for the sign bit of a [double-precision floating-po
151151

152152
<section class="related">
153153

154+
* * *
155+
156+
## See Also
157+
158+
- <span class="package-name">[`@stdlib/constants/float64/high-word-exponent-mask`][@stdlib/constants/float64/high-word-exponent-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the exponent of a double-precision floating-point number.</span>
159+
- <span class="package-name">[`@stdlib/constants/float64/high-word-significand-mask`][@stdlib/constants/float64/high-word-significand-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the significand of a double-precision floating-point number.</span>
160+
- <span class="package-name">[`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]</span><span class="delimiter">: </span><span class="description">high word mask for excluding the sign bit of a double-precision floating-point number.</span>
161+
154162
</section>
155163

156164
<!-- /.related -->
@@ -161,6 +169,16 @@ Macro for the high word mask for the sign bit of a [double-precision floating-po
161169

162170
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
163171

172+
<!-- <related-links> -->
173+
174+
[@stdlib/constants/float64/high-word-exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-exponent-mask
175+
176+
[@stdlib/constants/float64/high-word-significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-significand-mask
177+
178+
[@stdlib/constants/float64/high-word-abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-abs-mask
179+
180+
<!-- </related-links> -->
181+
164182
</section>
165183

166184
<!-- /.links -->

lib/node_modules/@stdlib/math/base/special/csch/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ int main( void ) {
171171
## See Also
172172

173173
- <span class="package-name">[`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosecant of a number.</span>
174+
- <span class="package-name">[`@stdlib/math/base/special/csc`][@stdlib/math/base/special/csc]</span><span class="delimiter">: </span><span class="description">compute the cosecant of a number.</span>
174175
- <span class="package-name">[`@stdlib/math/base/special/coth`][@stdlib/math/base/special/coth]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic cotangent of a number.</span>
175176
- <span class="package-name">[`@stdlib/math/base/special/sinh`][@stdlib/math/base/special/sinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic sine of a double-precision floating-point number.</span>
176177

@@ -188,6 +189,8 @@ int main( void ) {
188189

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

192+
[@stdlib/math/base/special/csc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csc
193+
191194
[@stdlib/math/base/special/coth]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/coth
192195

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

0 commit comments

Comments
 (0)