From 5de3771c5e4933569cc73db9111f370b1bf50dc0 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Tue, 24 Jun 2025 02:49:40 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/_tools/eslint/rules/README.md | 2 +- lib/node_modules/@stdlib/assert/README.md | 6 +++++ lib/node_modules/@stdlib/stats/base/README.md | 24 ------------------- 3 files changed, 7 insertions(+), 25 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md index 2358af28e5fb..7734f5f5275d 100644 --- a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md +++ b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md @@ -129,7 +129,7 @@ var eslint = rules; - [`jsdoc-link-title-style`][@stdlib/_tools/eslint/rules/jsdoc-link-title-style]: ESLint rule to enforce that link and definition titles use specified quotes in JSDoc descriptions. - [`jsdoc-list-item-bullet-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-bullet-indent]: ESLint rule to prevent unnecessary indentation of Markdown list item bullets in JSDoc descriptions. - [`jsdoc-list-item-content-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-content-indent]: ESLint rule to prevent mixed indentation in Markdown list item content in JSDoc descriptions. -- [`jsdoc-list-item-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-indent]: ESLint rule to spacing between a list item’s bullet and its content to violate a given style in JSDoc descriptions. +- [`jsdoc-list-item-indent`][@stdlib/_tools/eslint/rules/jsdoc-list-item-indent]: ESLint rule to enforce spacing between a list item’s bullet and its content to match a given style in JSDoc descriptions. - [`jsdoc-list-item-spacing`][@stdlib/_tools/eslint/rules/jsdoc-list-item-spacing]: ESLint rule to enforce consistent list item spacing in JSDoc descriptions. - [`jsdoc-main-export`][@stdlib/_tools/eslint/rules/jsdoc-main-export]: ESLint rule to enforce that the JSDoc comment documenting a package's main export adheres to `stdlib` conventions and contains the correct package path. - [`jsdoc-markdown-remark`][@stdlib/_tools/eslint/rules/jsdoc-markdown-remark]: ESLint rule to lint JSDoc descriptions using remark. diff --git a/lib/node_modules/@stdlib/assert/README.md b/lib/node_modules/@stdlib/assert/README.md index 01ee22847e7a..c7cea2f66445 100644 --- a/lib/node_modules/@stdlib/assert/README.md +++ b/lib/node_modules/@stdlib/assert/README.md @@ -491,6 +491,8 @@ The remaining namespace utilities are as follows: - [`isSnakecase( value )`][@stdlib/assert/is-snakecase]: test if a value is a string in snake case. - [`isStartcase( value )`][@stdlib/assert/is-startcase]: test if a value is a startcase string. - [`isStrictEqual( a, b )`][@stdlib/assert/is-strict-equal]: test if two arguments are strictly equal. +- [`isStructConstructorLike( value )`][@stdlib/assert/is-struct-constructor-like]: test if a value is struct constructor-like. +- [`isStruct( value )`][@stdlib/assert/is-struct]: test if a value is a `struct` instance. - [`isTruthy( value )`][@stdlib/assert/is-truthy]: test if a value is truthy. - [`isUNCPath( value )`][@stdlib/assert/is-unc-path]: test if a value is a UNC path. - [`isUndefinedOrNull( value )`][@stdlib/assert/is-undefined-or-null]: test if a value is undefined or null. @@ -771,6 +773,10 @@ console.log( objectKeys( assert ) ); [@stdlib/assert/is-strict-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-strict-equal +[@stdlib/assert/is-struct-constructor-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-struct-constructor-like + +[@stdlib/assert/is-struct]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-struct + [@stdlib/assert/is-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-truthy [@stdlib/assert/is-unc-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-unc-path diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index c3d44b3a70bd..0a3782b8f26f 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -61,14 +61,6 @@ The namespace contains the following statistical functions: - [`cumaxabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumaxabs]: calculate the cumulative maximum absolute value of a strided array. - [`cumin( N, x, strideX, y, strideY )`][@stdlib/stats/base/cumin]: calculate the cumulative minimum of a strided array. - [`cuminabs( N, x, strideX, y, strideY )`][@stdlib/stats/base/cuminabs]: calculate the cumulative minimum absolute value of a strided array. -- [`dmeanstdev( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanstdev]: calculate the mean and standard deviation of a double-precision floating-point strided array. -- [`dmeanstdevpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanstdevpn]: calculate the mean and standard deviation of a double-precision floating-point strided array using a two-pass algorithm. -- [`dmeanvar( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanvar]: calculate the mean and variance of a double-precision floating-point strided array. -- [`dmeanvarpn( N, correction, x, strideX, out, strideOut )`][@stdlib/stats/strided/dmeanvarpn]: calculate the mean and variance of a double-precision floating-point strided array using a two-pass algorithm. -- [`nanmean( N, x, strideX )`][@stdlib/stats/strided/nanmean]: calculate the arithmetic mean of a strided array, ignoring `NaN` values. -- [`nanmeanors( N, x, strideX )`][@stdlib/stats/strided/nanmeanors]: calculate the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation. -- [`nanmeanpn( N, x, strideX )`][@stdlib/stats/strided/nanmeanpn]: calculate the arithmetic mean of a strided array, ignoring `NaN` values and using a two-pass error correction algorithm. -- [`nanmeanwd( N, x, strideX )`][@stdlib/stats/strided/nanmeanwd]: calculate the arithmetic mean of a strided array, ignoring `NaN` values and using Welford's algorithm. - [`nanmskmax( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskmax]: calculate the maximum value of a strided array according to a mask, ignoring `NaN` values. - [`nanmskmin( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskmin]: calculate the minimum value of a strided array according to a mask, ignoring `NaN` values. - [`nanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/nanmskrange]: calculate the range of a strided array according to a mask, ignoring `NaN` values. @@ -179,22 +171,6 @@ console.log( objectKeys( ns ) ); [@stdlib/stats/base/cuminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/cuminabs -[@stdlib/stats/strided/dmeanstdev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanstdev - -[@stdlib/stats/strided/dmeanstdevpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanstdevpn - -[@stdlib/stats/strided/dmeanvar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanvar - -[@stdlib/stats/strided/dmeanvarpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmeanvarpn - -[@stdlib/stats/strided/nanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmean - -[@stdlib/stats/strided/nanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanors - -[@stdlib/stats/strided/nanmeanpn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanpn - -[@stdlib/stats/strided/nanmeanwd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/nanmeanwd - [@stdlib/stats/base/nanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmskmax [@stdlib/stats/base/nanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmskmin