Skip to content

Commit 6f019ca

Browse files
authored
docs: update namespace table of contents
PR-URL: #7472 Reviewed-by: Athan Reines <[email protected]>
1 parent 1bb671f commit 6f019ca

File tree

3 files changed

+7
-25
lines changed

3 files changed

+7
-25
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ var eslint = rules;
129129
- <span class="signature">[`jsdoc-link-title-style`][@stdlib/_tools/eslint/rules/jsdoc-link-title-style]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that link and definition titles use specified quotes in JSDoc descriptions.</span>
130130
- <span class="signature">[`jsdoc-list-item-bullet-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-bullet-indent]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unnecessary indentation of Markdown list item bullets in JSDoc descriptions.</span>
131131
- <span class="signature">[`jsdoc-list-item-content-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-content-indent]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent mixed indentation in Markdown list item content in JSDoc descriptions.</span>
132-
- <span class="signature">[`jsdoc-list-item-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-indent]</span><span class="delimiter">: </span><span class="description">ESLint rule to spacing between a list item’s bullet and its content to violate a given style in JSDoc descriptions.</span>
132+
- <span class="signature">[`jsdoc-list-item-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-indent]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce spacing between a list item’s bullet and its content to match a given style in JSDoc descriptions.</span>
133133
- <span class="signature">[`jsdoc-list-item-spacing`][@stdlib/_tools/eslint/rules/jsdoc-list-item-spacing]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce consistent list item spacing in JSDoc descriptions.</span>
134134
- <span class="signature">[`jsdoc-main-export`][@stdlib/_tools/eslint/rules/jsdoc-main-export]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that the JSDoc comment documenting a package's main export adheres to `stdlib` conventions and contains the correct package path.</span>
135135
- <span class="signature">[`jsdoc-markdown-remark`][@stdlib/_tools/eslint/rules/jsdoc-markdown-remark]</span><span class="delimiter">: </span><span class="description">ESLint rule to lint JSDoc descriptions using remark.</span>

lib/node_modules/@stdlib/assert/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,8 @@ The remaining namespace utilities are as follows:
491491
- <span class="signature">[`isSnakecase( value )`][@stdlib/assert/is-snakecase]</span><span class="delimiter">: </span><span class="description">test if a value is a string in snake case.</span>
492492
- <span class="signature">[`isStartcase( value )`][@stdlib/assert/is-startcase]</span><span class="delimiter">: </span><span class="description">test if a value is a startcase string.</span>
493493
- <span class="signature">[`isStrictEqual( a, b )`][@stdlib/assert/is-strict-equal]</span><span class="delimiter">: </span><span class="description">test if two arguments are strictly equal.</span>
494+
- <span class="signature">[`isStructConstructorLike( value )`][@stdlib/assert/is-struct-constructor-like]</span><span class="delimiter">: </span><span class="description">test if a value is struct constructor-like.</span>
495+
- <span class="signature">[`isStruct( value )`][@stdlib/assert/is-struct]</span><span class="delimiter">: </span><span class="description">test if a value is a `struct` instance.</span>
494496
- <span class="signature">[`isTruthy( value )`][@stdlib/assert/is-truthy]</span><span class="delimiter">: </span><span class="description">test if a value is truthy.</span>
495497
- <span class="signature">[`isUNCPath( value )`][@stdlib/assert/is-unc-path]</span><span class="delimiter">: </span><span class="description">test if a value is a UNC path.</span>
496498
- <span class="signature">[`isUndefinedOrNull( value )`][@stdlib/assert/is-undefined-or-null]</span><span class="delimiter">: </span><span class="description">test if a value is undefined or null.</span>
@@ -771,6 +773,10 @@ console.log( objectKeys( assert ) );
771773

772774
[@stdlib/assert/is-strict-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-strict-equal
773775

776+
[@stdlib/assert/is-struct-constructor-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-struct-constructor-like
777+
778+
[@stdlib/assert/is-struct]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-struct
779+
774780
[@stdlib/assert/is-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-truthy
775781

776782
[@stdlib/assert/is-unc-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-unc-path

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

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,6 @@ The namespace contains the following statistical functions:
6161
- <span class="signature">[`cumaxabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumaxabs]</span><span class="delimiter">: </span><span class="description">calculate the cumulative maximum absolute value of a strided array.</span>
6262
- <span class="signature">[`cumin( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumin]</span><span class="delimiter">: </span><span class="description">calculate the cumulative minimum of a strided array.</span>
6363
- <span class="signature">[`cuminabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cuminabs]</span><span class="delimiter">: </span><span class="description">calculate the cumulative minimum absolute value of a strided array.</span>
64-
- <span class="signature">[`dmeanstdev( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanstdev]</span><span class="delimiter">: </span><span class="description">calculate the mean and standard deviation of a double-precision floating-point strided array.</span>
65-
- <span class="signature">[`dmeanstdevpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/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>
66-
- <span class="signature">[`dmeanvar( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanvar]</span><span class="delimiter">: </span><span class="description">calculate the mean and variance of a double-precision floating-point strided array.</span>
67-
- <span class="signature">[`dmeanvarpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/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>
68-
- <span class="signature">[`nanmean( N, x, strideX )`][@stdlib/stats/strided/nanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a strided array, ignoring `NaN` values.</span>
69-
- <span class="signature">[`nanmeanors( N, x, strideX )`][@stdlib/stats/strided/nanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation.</span>
70-
- <span class="signature">[`nanmeanpn( N, x, strideX )`][@stdlib/stats/strided/nanmeanpn]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a strided array, ignoring `NaN` values and using a two-pass error correction algorithm.</span>
71-
- <span class="signature">[`nanmeanwd( N, x, strideX )`][@stdlib/stats/strided/nanmeanwd]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a strided array, ignoring `NaN` values and using Welford's algorithm.</span>
7264
- <span class="signature">[`nanmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array according to a mask, ignoring `NaN` values.</span>
7365
- <span class="signature">[`nanmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a strided array according to a mask, ignoring `NaN` values.</span>
7466
- <span class="signature">[`nanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a strided array according to a mask, ignoring `NaN` values.</span>
@@ -179,22 +171,6 @@ console.log( objectKeys( ns ) );
179171

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

182-
[@stdlib/stats/strided/dmeanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanstdev
183-
184-
[@stdlib/stats/strided/dmeanstdevpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanstdevpn
185-
186-
[@stdlib/stats/strided/dmeanvar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanvar
187-
188-
[@stdlib/stats/strided/dmeanvarpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanvarpn
189-
190-
[@stdlib/stats/strided/nanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmean
191-
192-
[@stdlib/stats/strided/nanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanors
193-
194-
[@stdlib/stats/strided/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanpn
195-
196-
[@stdlib/stats/strided/nanmeanwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanwd
197-
198174
[@stdlib/stats/base/nanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmskmax
199175

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

0 commit comments

Comments
 (0)