Skip to content

docs: update namespace table of contents #5513

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
merged 1 commit into from
Feb 28, 2025
Merged

docs: update namespace table of contents #5513

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 @@ -73,6 +73,7 @@ var eslint = rules;
- <span class="signature">[`no-internal-require`][@stdlib/_tools/eslint/rules/no-internal-require]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls into internals of another stdlib package.</span>
- <span class="signature">[`no-multiple-empty-lines`][@stdlib/_tools/eslint/rules/no-multiple-empty-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that that code does not contain multiple blank lines.</span>
- <span class="signature">[`no-nested-require`][@stdlib/_tools/eslint/rules/no-nested-require]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that one does not use nested property access for `require()` expressions.</span>
- <span class="signature">[`no-new-array`][@stdlib/_tools/eslint/rules/no-new-array]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing the use of the `new Array()` constructor.</span>
- <span class="signature">[`no-redeclare`][@stdlib/_tools/eslint/rules/no-redeclare]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing variable redeclarations.</span>
- <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>
Expand Down Expand Up @@ -412,6 +413,8 @@ console.log( getKeys( rules ) );

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

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

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

[@stdlib/_tools/eslint/rules/no-require-absolute-path]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-require-absolute-path
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ var o = blas;
- <span class="signature">[`gcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/gcopy]</span><span class="delimiter">: </span><span class="description">copy values from `x` into `y`.</span>
- <span class="signature">[`gdot( N, x, strideX, y, strideY )`][@stdlib/blas/base/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two vectors.</span>
- <span class="signature">[`gnrm2( N, x, stride )`][@stdlib/blas/base/gnrm2]</span><span class="delimiter">: </span><span class="description">calculate the L2-norm of a vector.</span>
- <span class="signature">[`gscal( N, alpha, x, stride )`][@stdlib/blas/base/gscal]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant `alpha`.</span>
- <span class="signature">[`gscal( N, alpha, x, stride )`][@stdlib/blas/base/gscal]</span><span class="delimiter">: </span><span class="description">multiply a vector by a scalar constant.</span>
- <span class="signature">[`gswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
- <span class="signature">[`idamax( N, x, strideX )`][@stdlib/blas/base/idamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value.</span>
- <span class="signature">[`isamax( N, x, strideX )`][@stdlib/blas/base/isamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value.</span>
Expand Down
6 changes: 0 additions & 6 deletions lib/node_modules/@stdlib/math/base/ops/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ The namespace contains the following functions:
- <span class="signature">[`csubf( z1, z2 )`][@stdlib/math/base/ops/csubf]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
- <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>
- <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>
- <span class="signature">[`subf( x, y )`][@stdlib/number/float32/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two single-precision floating-point numbers.</span>
- <span class="signature">[`umul( a, b )`][@stdlib/number/uint32/base/mul]</span><span class="delimiter">: </span><span class="description">perform C-like multiplication of two unsigned 32-bit integers.</span>
- <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>

</div>
Expand Down Expand Up @@ -131,10 +129,6 @@ console.log( ns.imuldw( 0x80000000|0, 0x40000000|0 ) );

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

[@stdlib/number/float32/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/sub

[@stdlib/number/uint32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint32/base/mul

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

<!-- </toc-links> -->
Expand Down
Loading