Skip to content

Commit b270977

Browse files
committed
docs: update related packages sections
1 parent 773e934 commit b270977

File tree

6 files changed

+69
-3
lines changed

6 files changed

+69
-3
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ int main( void ) {
307307
308308
## See Also
309309
310-
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
311-
- <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>
310+
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
311+
- <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>
312312
313313
</section>
314314

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

+8
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,12 @@ Macro for the maximum [safe][safe-integers] [Fibonacci number][fibonacci-number]
149149

150150
<section class="related">
151151

152+
* * *
153+
154+
## See Also
155+
156+
- <span class="package-name">[`@stdlib/constants/float64/max-safe-fibonacci`][@stdlib/constants/float64/max-safe-fibonacci]</span><span class="delimiter">: </span><span class="description">maximum safe Fibonacci number when stored in double-precision floating-point format.</span>
157+
152158
</section>
153159

154160
<!-- /.related -->
@@ -165,6 +171,8 @@ Macro for the maximum [safe][safe-integers] [Fibonacci number][fibonacci-number]
165171

166172
<!-- <related-links> -->
167173

174+
[@stdlib/constants/float64/max-safe-fibonacci]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-safe-fibonacci
175+
168176
<!-- </related-links> -->
169177

170178
</section>

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ logEach( 'He_%d(%.3f) = %.3f', 3, x, y );
170170

171171
## See Also
172172

173-
- <span class="package-name">[`@stdlib/math/base/tools/evalpoly`][@stdlib/math/base/tools/evalpoly]</span><span class="delimiter">: </span><span class="description">evaluate a polynomial.</span>
173+
- <span class="package-name">[`@stdlib/math/base/tools/evalpoly`][@stdlib/math/base/tools/evalpoly]</span><span class="delimiter">: </span><span class="description">evaluate a polynomial using double-precision floating-point arithmetic.</span>
174174
- <span class="package-name">[`@stdlib/math/base/tools/hermitepoly`][@stdlib/math/base/tools/hermitepoly]</span><span class="delimiter">: </span><span class="description">evaluate a physicist's Hermite polynomial.</span>
175175

176176
</section>

lib/node_modules/@stdlib/ndarray/to-fancy/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,15 @@ console.log( toArray( y4 ) );
307307

308308
<section class="related">
309309

310+
* * *
311+
312+
## See Also
313+
314+
- <span class="package-name">[`@stdlib/array/to-fancy`][@stdlib/array/to-fancy]</span><span class="delimiter">: </span><span class="description">convert an array to an object supporting fancy indexing.</span>
315+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
316+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
317+
- <span class="package-name">[`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>
318+
310319
</section>
311320

312321
<!-- /.related -->
@@ -331,6 +340,16 @@ console.log( toArray( y4 ) );
331340

332341
[@stdlib/slice/seq2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/seq2multislice
333342

343+
<!-- <related-links> -->
344+
345+
[@stdlib/array/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/to-fancy
346+
347+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
348+
349+
[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy
350+
351+
<!-- </related-links> -->
352+
334353
</section>
335354

336355
<!-- /.links -->

lib/node_modules/@stdlib/string/base/kebabcase/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,16 @@ out = kebabcase( str );
9393

9494
<section class="related">
9595

96+
* * *
97+
98+
## See Also
99+
100+
- <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>
101+
- <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>
102+
- <span class="package-name">[`@stdlib/string/base/pascalcase`][@stdlib/string/base/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
103+
- <span class="package-name">[`@stdlib/string/base/snakecase`][@stdlib/string/base/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
104+
- <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>
105+
96106
</section>
97107

98108
<!-- /.related -->
@@ -101,6 +111,20 @@ out = kebabcase( str );
101111

102112
<section class="links">
103113

114+
<!-- <related-links> -->
115+
116+
[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase
117+
118+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
119+
120+
[@stdlib/string/base/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/pascalcase
121+
122+
[@stdlib/string/base/snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/snakecase
123+
124+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
125+
126+
<!-- </related-links> -->
127+
104128
</section>
105129

106130
<!-- /.links -->

lib/node_modules/@stdlib/string/left-trim-n/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,13 @@ baz~~~
200200

201201
<section class="related">
202202

203+
* * *
204+
205+
## See Also
206+
207+
- <span class="package-name">[`@stdlib/string/right-trim-n`][@stdlib/string/right-trim-n]</span><span class="delimiter">: </span><span class="description">trim `n` characters from the end of a string.</span>
208+
- <span class="package-name">[`@stdlib/string/trim`][@stdlib/string/trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning and end of a string.</span>
209+
203210
</section>
204211

205212
<!-- /.related -->
@@ -212,6 +219,14 @@ baz~~~
212219

213220
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
214221

222+
<!-- <related-links> -->
223+
224+
[@stdlib/string/right-trim-n]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/right-trim-n
225+
226+
[@stdlib/string/trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/trim
227+
228+
<!-- </related-links> -->
229+
215230
</section>
216231

217232
<!-- /.links -->

0 commit comments

Comments
 (0)