Skip to content

Commit a973708

Browse files
authored
docs: update namespace table of contents
PR-URL: #6741 Reviewed-by: Athan Reines <[email protected]>
1 parent 28a1564 commit a973708

File tree

4 files changed

+43
-1
lines changed

4 files changed

+43
-1
lines changed

Diff for: lib/node_modules/@stdlib/array/base/banded/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ The namespace exports the following:
5353

5454
<!-- <toc pattern="*"> -->
5555

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`filled2dBy( shape, ku, kl, fill, clbk[, thisArg] )`][@stdlib/array/base/banded/filled2d-by]</span><span class="delimiter">: </span><span class="description">create a filled two-dimensional banded nested array according to a provided callback function.</span>
59+
- <span class="signature">[`toCompact( arr, ku, kl, colexicographic )`][@stdlib/array/base/banded/to-compact]</span><span class="delimiter">: </span><span class="description">convert a two-dimensional banded nested array to compact banded storage.</span>
60+
61+
</div>
62+
5663
<!-- </toc> -->
5764

5865
</section>
@@ -100,6 +107,14 @@ console.log( objectKeys( ns ) );
100107

101108
<section class="links">
102109

110+
<!-- <toc-links> -->
111+
112+
[@stdlib/array/base/banded/filled2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/banded/filled2d-by
113+
114+
[@stdlib/array/base/banded/to-compact]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/banded/to-compact
115+
116+
<!-- </toc-links> -->
117+
103118
</section>
104119

105120
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/array/base/symmetric-banded/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,13 @@ The namespace exports the following:
5353

5454
<!-- <toc pattern="*"> -->
5555

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`filled2dBy( N, k, fill, clbk[, thisArg] )`][@stdlib/array/base/symmetric-banded/filled2d-by]</span><span class="delimiter">: </span><span class="description">create a filled two-dimensional symmetric banded nested array according to a provided callback function.</span>
59+
- <span class="signature">[`toCompact( uplo, arr, k, colexicographic )`][@stdlib/array/base/symmetric-banded/to-compact]</span><span class="delimiter">: </span><span class="description">convert a two-dimensional symmetric banded nested array to compact banded storage.</span>
60+
61+
</div>
62+
5663
<!-- </toc> -->
5764

5865
</section>
@@ -100,6 +107,14 @@ console.log( objectKeys( ns ) );
100107

101108
<section class="links">
102109

110+
<!-- <toc-links> -->
111+
112+
[@stdlib/array/base/symmetric-banded/filled2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric-banded/filled2d-by
113+
114+
[@stdlib/array/base/symmetric-banded/to-compact]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric-banded/to-compact
115+
116+
<!-- </toc-links> -->
117+
103118
</section>
104119

105120
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/array/base/symmetric/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ The namespace exports the following:
5353

5454
<!-- <toc pattern="*"> -->
5555

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`filled2dBy( N, clbk[, thisArg] )`][@stdlib/array/base/symmetric/filled2d-by]</span><span class="delimiter">: </span><span class="description">create a filled two-dimensional symmetric nested array according to a provided callback function.</span>
59+
60+
</div>
61+
5662
<!-- </toc> -->
5763

5864
</section>
@@ -100,6 +106,12 @@ console.log( objectKeys( ns ) );
100106

101107
<section class="links">
102108

109+
<!-- <toc-links> -->
110+
111+
[@stdlib/array/base/symmetric/filled2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric/filled2d-by
112+
113+
<!-- </toc-links> -->
114+
103115
</section>
104116

105117
<!-- /.links -->

Diff for: lib/node_modules/@stdlib/math/base/special/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ var fcns = special;
189189
- <span class="signature">[`round2( x )`][@stdlib/math/base/special/round2]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest power of two on a linear scale.</span>
190190
- <span class="signature">[`roundb( x, n, b )`][@stdlib/math/base/special/roundb]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest multiple of b^n on a linear scale.</span>
191191
- <span class="signature">[`roundn( x, n )`][@stdlib/math/base/special/roundn]</span><span class="delimiter">: </span><span class="description">round a double-precision floating-point number to the nearest multiple of 10^n.</span>
192-
- <span class="signature">[`roundsd( x, n[, b] )`][@stdlib/math/base/special/roundsd]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest number with `n` significant figures.</span>
192+
- <span class="signature">[`roundsd( x, n[, b] )`][@stdlib/math/base/special/roundsd]</span><span class="delimiter">: </span><span class="description">round a double-precision floating-point number to the nearest value with `n` significant figures.</span>
193193
- <span class="signature">[`signum( x )`][@stdlib/math/base/special/signum]</span><span class="delimiter">: </span><span class="description">signum function.</span>
194194
- <span class="signature">[`signumf( x )`][@stdlib/math/base/special/signumf]</span><span class="delimiter">: </span><span class="description">signum function.</span>
195195
- <span class="signature">[`trunc( x )`][@stdlib/math/base/special/trunc]</span><span class="delimiter">: </span><span class="description">round a double-precision floating-point number toward zero.</span>

0 commit comments

Comments
 (0)