Skip to content

Commit bf18c77

Browse files
authored
docs: update namespace table of contents
PR-URL: #5351 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 87172d0 commit bf18c77

File tree

3 files changed

+1
-7
lines changed

3 files changed

+1
-7
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ var eslint = rules;
157157
- <span class="signature">[`jsdoc-no-shortcut-reference-link`][@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-link]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent shortcut Markdown reference links from being used in JSDoc descriptions.</span>
158158
- <span class="signature">[`jsdoc-no-space-aligned-asterisks`][@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks]</span><span class="delimiter">: </span><span class="description">ESLint rule to disallow space-aligned asterisks for JSDoc comments.</span>
159159
- <span class="signature">[`jsdoc-no-table-indentation`][@stdlib/_tools/eslint/rules/jsdoc-no-table-indentation]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unnecessary indentation of Markdown tables in JSDoc descriptions.</span>
160-
- <span class="signature">[`jsdoc-no-tabs`][@stdlib/_tools/eslint/rules/jsdoc-no-tabs]</span><span class="delimiter">: </span><span class="description">ESLint rule forbidding the use of tabs in JSDoc descriptions.</span>
160+
- <span class="signature">[`jsdoc-no-tabs`][@stdlib/_tools/eslint/rules/jsdoc-no-tabs]</span><span class="delimiter">: </span><span class="description">ESLint rule forbidding the use of tabs in JSDoc comments.</span>
161161
- <span class="signature">[`jsdoc-no-undefined-references`][@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent references to undefined Markdown definitions in JSDoc descriptions.</span>
162162
- <span class="signature">[`jsdoc-no-unused-definitions`][@stdlib/_tools/eslint/rules/jsdoc-no-unused-definitions]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unused Markdown definitions in JSDoc descriptions.</span>
163163
- <span class="signature">[`jsdoc-ordered-list-marker-style`][@stdlib/_tools/eslint/rules/jsdoc-ordered-list-marker-style]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce a specified Markdown ordered list marker style in JSDoc descriptions.</span>

lib/node_modules/@stdlib/math/base/ops/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ The namespace contains the following functions:
5454
- <span class="signature">[`imul( a, b )`][@stdlib/math/base/ops/imul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two signed 32-bit integers.</span>
5555
- <span class="signature">[`imuldw( a, b )`][@stdlib/math/base/ops/imuldw]</span><span class="delimiter">: </span><span class="description">compute the double word product of two signed 32-bit integers.</span>
5656
- <span class="signature">[`mulf( x, y )`][@stdlib/math/base/ops/mulf]</span><span class="delimiter">: </span><span class="description">multiply two single-precision floating-point numbers.</span>
57-
- <span class="signature">[`sub( x, y )`][@stdlib/number/float64/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision floating-point numbers.</span>
5857
- <span class="signature">[`subf( x, y )`][@stdlib/math/base/ops/subf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>
5958
- <span class="signature">[`umul( a, b )`][@stdlib/math/base/ops/umul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two unsigned 32-bit integers.</span>
6059
- <span class="signature">[`umuldw( a, b )`][@stdlib/math/base/ops/umuldw]</span><span class="delimiter">: </span><span class="description">compute the double word product of two unsigned 32-bit integers.</span>
@@ -147,8 +146,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );
147146

148147
[@stdlib/math/base/ops/mulf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mulf
149148

150-
[@stdlib/number/float64/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/sub
151-
152149
[@stdlib/math/base/ops/subf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/subf
153150

154151
[@stdlib/math/base/ops/umul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/umul

lib/node_modules/@stdlib/stats/base/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ The namespace contains the following statistical functions:
6868
- <span class="signature">[`dmeanstdevpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the mean and standard deviation of a double-precision floating-point strided array using a two-pass algorithm.</span>
6969
- <span class="signature">[`dmeanvar( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanvar]</span><span class="delimiter">: </span><span class="description">calculate the mean and variance of a double-precision floating-point strided array.</span>
7070
- <span class="signature">[`dmeanvarpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/base/dmeanvarpn]</span><span class="delimiter">: </span><span class="description">calculate the mean and variance of a double-precision floating-point strided array using a two-pass algorithm.</span>
71-
- <span class="signature">[`dminsorted( N, x, strideX )`][@stdlib/stats/strided/dminsorted]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a sorted double-precision floating-point strided array.</span>
7271
- <span class="signature">[`dmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a double-precision floating-point strided array according to a mask.</span>
7372
- <span class="signature">[`dmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a double-precision floating-point strided array according to a mask.</span>
7473
- <span class="signature">[`dmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array according to a mask.</span>
@@ -328,8 +327,6 @@ console.log( objectKeys( ns ) );
328327

329328
[@stdlib/stats/base/dmeanvarpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmeanvarpn
330329

331-
[@stdlib/stats/strided/dminsorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dminsorted
332-
333330
[@stdlib/stats/base/dmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmskmax
334331

335332
[@stdlib/stats/base/dmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dmskmin

0 commit comments

Comments
 (0)