Skip to content

Commit 769b921

Browse files
stdlib-botkgryte
andauthored
docs: update related packages sections
PR-URL: #4638 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent 99378ce commit 769b921

File tree

4 files changed

+49
-2
lines changed

4 files changed

+49
-2
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ Macro for the [natural logarithm][@stdlib/math/base/special/ln] of `10` as a sin
124124

125125
## See Also
126126

127-
- <span class="package-name">[`@stdlib/constants/float32/ln-two`][@stdlib/constants/float32/ln-two]</span><span class="delimiter">: </span><span class="description">natural logarithm of single-precision floating-point number 2.</span>
127+
- <span class="package-name">[`@stdlib/constants/float32/ln-two`][@stdlib/constants/float32/ln-two]</span><span class="delimiter">: </span><span class="description">natural logarithm of 2 as a single-precision floating-point number.</span>
128+
- <span class="package-name">[`@stdlib/constants/float64/ln-ten`][@stdlib/constants/float64/ln-ten]</span><span class="delimiter">: </span><span class="description">natural logarithm of 10.</span>
128129

129130
</section>
130131

@@ -140,6 +141,8 @@ Macro for the [natural logarithm][@stdlib/math/base/special/ln] of `10` as a sin
140141

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

144+
[@stdlib/constants/float64/ln-ten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/ln-ten
145+
143146
<!-- </related-links> -->
144147

145148
</section>

lib/node_modules/@stdlib/math/strided/special/atanh-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,12 @@ console.log( y );
229229

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <span class="package-name">[`@stdlib/math/strided/special/atan-by`][@stdlib/math/strided/special/atan-by]</span><span class="delimiter">: </span><span class="description">compute the arctangent of each element retrieved from an input strided array via a callback function.</span>
237+
232238
</section>
233239

234240
<!-- /.related -->
@@ -243,6 +249,12 @@ console.log( y );
243249

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

252+
<!-- <related-links> -->
253+
254+
[@stdlib/math/strided/special/atan-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/atan-by
255+
256+
<!-- </related-links> -->
257+
246258
</section>
247259

248260
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/index/README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ var o = idx.toJSON();
474474
}
475475
```
476476

477-
will leak memory as `idx` is only consumed within an `if` block which never evaluates. In such scenarios, one should either refactor to avoid inadvertently holding onto memory or explicitly free the `ndindex`.
477+
will leak memory as `idx` is only consumed within an `if` block which never evaluates. In such scenarios, one should either refactor to avoid inadvertently holding onto memory or explicitly free the `ndindex`.
478478

479479
```javascript
480480
var array = require( '@stdlib/ndarray/array' );
@@ -574,6 +574,16 @@ console.log( 'Type: %s. Data type: %s.', o.type, o.dtype );
574574

575575
<section class="related">
576576

577+
* * *
578+
579+
## See Also
580+
581+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
582+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
583+
- <span class="package-name">[`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>
584+
- <span class="package-name">[`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray.</span>
585+
- <span class="package-name">[`@stdlib/ndarray/to-fancy`][@stdlib/ndarray/to-fancy]</span><span class="delimiter">: </span><span class="description">convert an ndarray to an object supporting fancy indexing.</span>
586+
577587
</section>
578588

579589
<!-- /.related -->
@@ -594,6 +604,16 @@ console.log( 'Type: %s. Data type: %s.', o.type, o.dtype );
594604

595605
[@stdlib/ndarray/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-fancy
596606

607+
<!-- <related-links> -->
608+
609+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
610+
611+
[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy
612+
613+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
614+
615+
<!-- </related-links> -->
616+
597617
</section>
598618

599619
<!-- /.links -->

lib/node_modules/@stdlib/slice/base/normalize-multi-slice/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,12 @@ console.log( '%s => %s', s1.toString(), s2.toString() );
177177

178178
<section class="related">
179179

180+
* * *
181+
182+
## See Also
183+
184+
- <span class="package-name">[`@stdlib/slice/base/normalize-slice`][@stdlib/slice/base/normalize-slice]</span><span class="delimiter">: </span><span class="description">normalize a Slice object.</span>
185+
180186
</section>
181187

182188
<!-- /.related -->
@@ -187,6 +193,12 @@ console.log( '%s => %s', s1.toString(), s2.toString() );
187193

188194
[@stdlib/slice/multi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/multi
189195

196+
<!-- <related-links> -->
197+
198+
[@stdlib/slice/base/normalize-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/normalize-slice
199+
200+
<!-- </related-links> -->
201+
190202
</section>
191203

192204
<!-- /.links -->

0 commit comments

Comments
 (0)