Skip to content

docs: update namespace table of contents #9076

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
Dec 16, 2025
+3 −3
Merged

docs: update namespace table of contents #9076

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 @@ -52,6 +52,7 @@ var eslint = rules;
<div class="namespace-toc">

- <span class="signature">[`capitalized-comments`][@stdlib/_tools/eslint/rules/capitalized-comments]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that comments start with an uppercase letter.</span>
- <span class="signature">[`doctest-annotation-spacing`][@stdlib/_tools/eslint/rules/doctest-annotation-spacing]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce spacing in return annotations in single-line comments.</span>
- <span class="signature">[`doctest-marker`][@stdlib/_tools/eslint/rules/doctest-marker]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce marker style conventions for return annotations.</span>
- <span class="signature">[`doctest-quote-props`][@stdlib/_tools/eslint/rules/doctest-quote-props]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that property names in return annotations are quoted using single quotes.</span>
- <span class="signature">[`doctest`][@stdlib/_tools/eslint/rules/doctest]</span><span class="delimiter">: </span><span class="description">ESLint rule to ensure return annotations match the actual output.</span>
Expand Down Expand Up @@ -374,6 +375,8 @@ console.log( getKeys( rules ) );

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

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

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

[@stdlib/_tools/eslint/rules/doctest-quote-props]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/doctest-quote-props
Expand Down
3 changes: 0 additions & 3 deletions lib/node_modules/@stdlib/utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ The namespace has the following sub-namespaces:

<div class="namespace-toc">

- <span class="signature">[`capitalizeKeys( obj )`][@stdlib/utils/capitalize-keys]</span><span class="delimiter">: </span><span class="description">convert the first letter of each object key to uppercase.</span>
- <span class="signature">[`commonKeys( obj1, obj2[, obj3[,...,objN]] )`][@stdlib/utils/common-keys]</span><span class="delimiter">: </span><span class="description">return the common own property names of two or more objects.</span>
- <span class="signature">[`deepGet( obj, path[, options] )`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="signature">[`deepSet( obj, path, value[, options] )`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>
Expand Down Expand Up @@ -514,8 +513,6 @@ console.log( objectKeys( utils ) );

[@stdlib/utils/while]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/while

[@stdlib/utils/capitalize-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/capitalize-keys

[@stdlib/utils/common-keys]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/common-keys

[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get
Expand Down