Skip to content

docs: update namespace table of contents #14083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Aug 9, 2026
+42 −0
Merged

docs: update namespace table of contents #14083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/_tools/eslint/rules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ var eslint = rules;
- <span class="signature">[`no-require-absolute-path`][@stdlib/_tools/eslint/rules/no-require-absolute-path]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` statements containing absolute file paths.</span>
- <span class="signature">[`no-require-index`][@stdlib/_tools/eslint/rules/no-require-index]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls which explicitly require `index.<ext>` files.</span>
- <span class="signature">[`no-self-require`][@stdlib/_tools/eslint/rules/no-self-require]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that modules do not require themselves.</span>
- <span class="signature">[`no-single-property-require`][@stdlib/_tools/eslint/rules/no-single-property-require]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing requiring an entire module when only a single property of the module is used.</span>
- <span class="signature">[`no-unassigned-require`][@stdlib/_tools/eslint/rules/no-unassigned-require]</span><span class="delimiter">: </span><span class="description">ESLint rule forbidding unassigned require statements.</span>
- <span class="signature">[`no-unnecessary-nested-functions`][@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unnecessary function nesting when inner functions don't depend on outer scope variables.</span>
- <span class="signature">[`repl-namespace-order`][@stdlib/_tools/eslint/rules/repl-namespace-order]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that packages are added to a REPL namespace object in alphabetical order according to alias (namespace key).</span>
Expand Down Expand Up @@ -440,6 +441,8 @@ console.log( getKeys( rules ) );

[@stdlib/_tools/eslint/rules/no-self-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-self-require

[@stdlib/_tools/eslint/rules/no-single-property-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-single-property-require

[@stdlib/_tools/eslint/rules/no-unassigned-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unassigned-require

[@stdlib/_tools/eslint/rules/no-unnecessary-nested-functions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-unnecessary-nested-functions
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,7 @@ To test whether a runtime environment supports certain features, the namespace i
- <span class="signature">[`hasMapSupport()`][@stdlib/assert/has-map-support]</span><span class="delimiter">: </span><span class="description">detect native `Map` support.</span>
- <span class="signature">[`hasMatchSymbolSupport()`][@stdlib/assert/has-match-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.match` support.</span>
- <span class="signature">[`hasNodeBufferSupport()`][@stdlib/assert/has-node-buffer-support]</span><span class="delimiter">: </span><span class="description">detect native `Buffer` support.</span>
- <span class="signature">[`hasPromiseSupport()`][@stdlib/assert/has-promise-support]</span><span class="delimiter">: </span><span class="description">detect native `Promise` support.</span>
- <span class="signature">[`hasProxySupport()`][@stdlib/assert/has-proxy-support]</span><span class="delimiter">: </span><span class="description">detect native `Proxy` support.</span>
- <span class="signature">[`hasReplaceSymbolSupport()`][@stdlib/assert/has-replace-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.replace` support.</span>
- <span class="signature">[`hasSearchSymbolSupport()`][@stdlib/assert/has-search-symbol-support]</span><span class="delimiter">: </span><span class="description">detect native `Symbol.search` support.</span>
Expand Down Expand Up @@ -903,6 +904,8 @@ console.log( objectKeys( assert ) );

[@stdlib/assert/has-node-buffer-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-node-buffer-support

[@stdlib/assert/has-promise-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-promise-support

[@stdlib/assert/has-proxy-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-proxy-support

[@stdlib/assert/has-replace-symbol-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-replace-symbol-support
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ var o = ns;
- <span class="signature">[`creplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/creplicate]</span><span class="delimiter">: </span><span class="description">replicate each element in a single-precision complex floating-point strided array a specified number of times.</span>
- <span class="signature">[`csum( N, x, strideX )`][@stdlib/blas/ext/base/csum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements.</span>
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`ctril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ctril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`ctriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ctriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`cunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`cwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/cwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a single-precision complex floating-point strided array `x` and assign the results to elements in a single-precision complex floating-point strided array `w`.</span>
Expand Down Expand Up @@ -167,6 +168,7 @@ var o = ns;
- <span class="signature">[`dsumors( N, x, strideX )`][@stdlib/blas/ext/base/dsumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using ordinary recursive summation.</span>
- <span class="signature">[`dsumpw( N, x, strideX )`][@stdlib/blas/ext/base/dsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using pairwise summation.</span>
- <span class="signature">[`dtril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/dtril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a double-precision floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`dtril2triu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/dtril2triu]</span><span class="delimiter">: </span><span class="description">reflect the lower triangular part of a double-precision floating-point matrix `A` into the upper triangular part of another matrix `B`.</span>
- <span class="signature">[`dtriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/dtriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a double-precision floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`dtriu2tril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/dtriu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a double-precision floating-point matrix `A` into the lower triangular part of another matrix `B`.</span>
- <span class="signature">[`dunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
Expand Down Expand Up @@ -275,6 +277,7 @@ var o = ns;
- <span class="signature">[`gsumpw( N, x, strideX )`][@stdlib/blas/ext/base/gsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using pairwise summation.</span>
- <span class="signature">[`gtril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gtriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a matrix `A` to another matrix `B`.</span>
- <span class="signature">[`gtriu2tril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/gtriu2tril]</span><span class="delimiter">: </span><span class="description">reflect the upper triangular part of a matrix A into the lower triangular part of another matrix B.</span>
- <span class="signature">[`gunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`gvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/gvander]</span><span class="delimiter">: </span><span class="description">generate a Vandermonde matrix.</span>
- <span class="signature">[`gwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/gwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a strided array `x` and assign the results to elements in a strided array `w`.</span>
Expand Down Expand Up @@ -411,6 +414,7 @@ var o = ns;
- <span class="signature">[`zreplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/zreplicate]</span><span class="delimiter">: </span><span class="description">replicate each element in a double-precision complex floating-point strided array a specified number of times.</span>
- <span class="signature">[`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements.</span>
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`ztril( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ztril]</span><span class="delimiter">: </span><span class="description">copy the lower triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`ztriu( order, M, N, k, A, LDA, B, LDB )`][@stdlib/blas/ext/base/ztriu]</span><span class="delimiter">: </span><span class="description">copy the upper triangular part of a double-precision complex floating-point matrix `A` to another matrix `B`.</span>
- <span class="signature">[`zunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`zwapx( N, alpha, x, strideX, w, strideW )`][@stdlib/blas/ext/base/zwapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision complex floating-point strided array `x` and assign the results to elements in a double-precision complex floating-point strided array `w`.</span>
Expand Down Expand Up @@ -507,6 +511,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csumkbn

[@stdlib/blas/ext/base/ctril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ctril

[@stdlib/blas/ext/base/ctriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ctriu

[@stdlib/blas/ext/base/cunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cunitspace
Expand Down Expand Up @@ -723,6 +729,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/dtril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dtril

[@stdlib/blas/ext/base/dtril2triu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dtril2triu

[@stdlib/blas/ext/base/dtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dtriu

[@stdlib/blas/ext/base/dtriu2tril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dtriu2tril
Expand Down Expand Up @@ -939,6 +947,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/gtriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtriu

[@stdlib/blas/ext/base/gtriu2tril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gtriu2tril

[@stdlib/blas/ext/base/gunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gunitspace

[@stdlib/blas/ext/base/gvander]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gvander
Expand Down Expand Up @@ -1211,6 +1221,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/zsumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsumkbn

[@stdlib/blas/ext/base/ztril]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ztril

[@stdlib/blas/ext/base/ztriu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ztriu

[@stdlib/blas/ext/base/zunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zunitspace
Expand Down
Loading