Skip to content

Commit d3d3d14

Browse files
docs: update related packages sections
PR-URL: #4149 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 6250a1f commit d3d3d14

File tree

9 files changed

+78
-8
lines changed

9 files changed

+78
-8
lines changed

lib/node_modules/@stdlib/array/base/filled-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ out = filledBy( 3, constantFunction( void 0 ) );
134134

135135
<section class="related">
136136

137+
* * *
138+
139+
## See Also
140+
141+
- <span class="package-name">[`@stdlib/array/base/filled`][@stdlib/array/base/filled]</span><span class="delimiter">: </span><span class="description">create a filled generic array.</span>
142+
137143
</section>
138144

139145
<!-- /.related -->
@@ -142,6 +148,12 @@ out = filledBy( 3, constantFunction( void 0 ) );
142148

143149
<section class="links">
144150

151+
<!-- <related-links> -->
152+
153+
[@stdlib/array/base/filled]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled
154+
155+
<!-- </related-links> -->
156+
145157
</section>
146158

147159
<!-- /.links -->

lib/node_modules/@stdlib/array/base/fillednd-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ out = filledndBy( [ 1, 1, 1, 3 ], constantFunction( void 0 ) );
134134

135135
<section class="related">
136136

137+
* * *
138+
139+
## See Also
140+
141+
- <span class="package-name">[`@stdlib/array/base/fillednd`][@stdlib/array/base/fillednd]</span><span class="delimiter">: </span><span class="description">create a filled n-dimensional nested array.</span>
142+
137143
</section>
138144

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

143149
<section class="links">
144150

151+
<!-- <related-links> -->
152+
153+
[@stdlib/array/base/fillednd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fillednd
154+
155+
<!-- </related-links> -->
156+
145157
</section>
146158

147159
<!-- /.links -->

lib/node_modules/@stdlib/assert/is-kebabcase/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,14 @@ true
169169

170170
<section class="related">
171171

172+
* * *
173+
174+
## See Also
175+
176+
- <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>
177+
178+
</section>
179+
172180
<!-- /.related -->
173181

174182
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -181,6 +189,8 @@ true
181189

182190
<!-- <related-links> -->
183191

192+
[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
193+
184194
<!-- </related-links> -->
185195

186196
</section>

lib/node_modules/@stdlib/blas/base/gscal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ console.log( x );
147147
## See Also
148148

149149
- <span class="package-name">[`@stdlib/blas/base/dscal`][@stdlib/blas/base/dscal]</span><span class="delimiter">: </span><span class="description">multiply a double-precision floating-point vector by a constant.</span>
150-
- <span class="package-name">[`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply x by a constant and add the result to y.</span>
150+
- <span class="package-name">[`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
151151
- <span class="package-name">[`@stdlib/blas/base/sscal`][@stdlib/blas/base/sscal]</span><span class="delimiter">: </span><span class="description">multiply a single-precision floating-point vector by a constant.</span>
152152

153153
</section>

lib/node_modules/@stdlib/blas/ext/base/dapxsum/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,10 @@ int main( void ) {
279279
280280
## See Also
281281
282-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using pairwise summation.</span>
282+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</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 using pairwise summation.</span>
283283
- <span class="package-name">[`@stdlib/blas/ext/base/dsum`][@stdlib/blas/ext/base/dsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements.</span>
284-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
285-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum.</span>
284+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
285+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum.</span>
286286
287287
</section>
288288

lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,10 @@ console.log( v );
175175

176176
## See Also
177177

178-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
179-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
178+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
179+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
180180
- <span class="package-name">[`@stdlib/blas/ext/base/gsumkbn`][@stdlib/blas/ext/base/gsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using an improved Kahan–Babuška algorithm.</span>
181-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
181+
- <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>
182182

183183
</section>
184184

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,14 @@ int main( void ) {
170170

171171
<section class="related">
172172

173+
* * *
174+
175+
## See Also
176+
177+
- <span class="package-name">[`@stdlib/math/base/special/asec`][@stdlib/math/base/special/asec]</span><span class="delimiter">: </span><span class="description">compute the inverse (arc) secant of a number.</span>
178+
- <span class="package-name">[`@stdlib/math/base/special/asech`][@stdlib/math/base/special/asech]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsecant of a number.</span>
179+
- <span class="package-name">[`@stdlib/math/base/special/acosf`][@stdlib/math/base/special/acosf]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a single-precision floating-point number.</span>
180+
173181
</section>
174182

175183
<!-- /.related -->
@@ -180,6 +188,16 @@ int main( void ) {
180188

181189
[arcsecant]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
182190

191+
<!-- <related-links> -->
192+
193+
[@stdlib/math/base/special/asec]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asec
194+
195+
[@stdlib/math/base/special/asech]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asech
196+
197+
[@stdlib/math/base/special/acosf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosf
198+
199+
<!-- </related-links> -->
200+
183201
</section>
184202

185203
<!-- /.links -->

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,14 @@ int main( void ) {
160160

161161
<section class="related">
162162

163+
* * *
164+
165+
## See Also
166+
167+
- <span class="package-name">[`@stdlib/math/base/special/atan`][@stdlib/math/base/special/atan]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a double-precision floating-point number.</span>
168+
- <span class="package-name">[`@stdlib/math/base/special/atanh`][@stdlib/math/base/special/atanh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of a double-precision floating-point number.</span>
169+
- <span class="package-name">[`@stdlib/math/base/special/acosf`][@stdlib/math/base/special/acosf]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a single-precision floating-point number.</span>
170+
163171
</section>
164172

165173
<!-- /.related -->
@@ -170,6 +178,16 @@ int main( void ) {
170178

171179
[arctangent]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
172180

181+
<!-- <related-links> -->
182+
183+
[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan
184+
185+
[@stdlib/math/base/special/atanh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanh
186+
187+
[@stdlib/math/base/special/acosf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosf
188+
189+
<!-- </related-links> -->
190+
173191
</section>
174192

175193
<!-- /.links -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ int main( void ) {
188188
## See Also
189189

190190
- <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>
191-
- <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>
191+
- <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>
192192

193193
</section>
194194

0 commit comments

Comments
 (0)