Skip to content
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.

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

Update namespace table of contents #1078

Merged
merged 1 commit into from
Aug 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/_tools/eslint/rules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ var eslint = rules;
- <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>
- <span class="signature">[`empty-line-before-comment`][@stdlib/_tools/eslint/rules/empty-line-before-comment]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce empty lines before comments.</span>
- <span class="signature">[`first-unit-test`][@stdlib/_tools/eslint/rules/first-unit-test]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that a tape file starts with the expected test.</span>
- <span class="signature">[`module-exports-last`][@stdlib/_tools/eslint/rules/module-exports-last]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that export statements appear at the end of a file.</span>
- <span class="signature">[`namespace-export-all`][@stdlib/_tools/eslint/rules/namespace-export-all]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that a namespace `index.js` exports all packages in the respective namespace directory.</span>
- <span class="signature">[`namespace-index-order`][@stdlib/_tools/eslint/rules/namespace-index-order]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that modules in a namespace `index.js` file are listed in alphabetical order according to module name.</span>
Expand All @@ -65,6 +66,7 @@ var eslint = rules;
- <span class="signature">[`no-builtin-math`][@stdlib/_tools/eslint/rules/no-builtin-math]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that `stdlib` equivalents are used instead of the built-in global `Math` object.</span>
- <span class="signature">[`no-dynamic-exports`][@stdlib/_tools/eslint/rules/no-dynamic-exports]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that only statically analyzable values are exported.</span>
- <span class="signature">[`no-dynamic-require`][@stdlib/_tools/eslint/rules/no-dynamic-require]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that `require()` calls have only string literals as arguments.</span>
- <span class="signature">[`no-empty-comments`][@stdlib/_tools/eslint/rules/no-empty-comments]</span><span class="delimiter">: </span><span class="description">ESLint rule to disallow empty comments.</span>
- <span class="signature">[`no-immediate-require`][@stdlib/_tools/eslint/rules/no-immediate-require]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that `require()` expressions are not immediately invoked.</span>
- <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>
Expand Down Expand Up @@ -143,12 +145,14 @@ var eslint = rules;
- <span class="signature">[`jsdoc-no-inline-padding`][@stdlib/_tools/eslint/rules/jsdoc-no-inline-padding]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent padding of Markdown inline nodes between their markers and content in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-literal-urls`][@stdlib/_tools/eslint/rules/jsdoc-no-literal-urls]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent URLs without angle-brackets from being used in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-missing-blank-lines`][@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to require blank lines between Markdown block nodes in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-multiple-blank-lines`][@stdlib/_tools/eslint/rules/jsdoc-no-multiple-blank-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent multiple blank lines in JSDoc comments.</span>
- <span class="signature">[`jsdoc-no-multiple-toplevel-headings`][@stdlib/_tools/eslint/rules/jsdoc-no-multiple-toplevel-headings]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent multiple top-level Markdown headings from being used in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-paragraph-content-indent`][@stdlib/_tools/eslint/rules/jsdoc-no-paragraph-content-indent]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent indentation of Markdown paragraph content in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-reference-like-url`][@stdlib/_tools/eslint/rules/jsdoc-no-reference-like-url]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent Markdown references from being used like URLs in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-shell-dollars`][@stdlib/_tools/eslint/rules/jsdoc-no-shell-dollars]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent shell code in Markdown fenced code blocks from being prefixed by dollar-characters in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-shortcut-reference-image`][@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-image]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent shortcut Markdown reference images from being used in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-shortcut-reference-link`][@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-link]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent shortcut Markdown reference links from being used in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-space-aligned-asterisks`][@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks]</span><span class="delimiter">: </span><span class="description">ESLint rule to disallow space-aligned asterisks for JSDoc comments.</span>
- <span class="signature">[`jsdoc-no-table-indentation`][@stdlib/_tools/eslint/rules/jsdoc-no-table-indentation]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent unnecessary indentation of Markdown tables in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-tabs`][@stdlib/_tools/eslint/rules/jsdoc-no-tabs]</span><span class="delimiter">: </span><span class="description">ESLint rule forbidding the use of tabs in JSDoc descriptions.</span>
- <span class="signature">[`jsdoc-no-undefined-references`][@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references]</span><span class="delimiter">: </span><span class="description">ESLint rule to prevent references to undefined Markdown definitions in JSDoc descriptions.</span>
Expand Down Expand Up @@ -305,6 +309,8 @@ console.log( getKeys( rules ) );

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

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

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

[@stdlib/_tools/eslint/rules/jsdoc-no-paragraph-content-indent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-no-paragraph-content-indent
Expand All @@ -317,6 +323,8 @@ console.log( getKeys( rules ) );

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

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

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

[@stdlib/_tools/eslint/rules/jsdoc-no-tabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-no-tabs
Expand Down Expand Up @@ -363,6 +371,8 @@ console.log( getKeys( rules ) );

[@stdlib/_tools/eslint/rules/empty-line-before-comment]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/empty-line-before-comment

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

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

[@stdlib/_tools/eslint/rules/namespace-export-all]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/namespace-export-all
Expand All @@ -381,6 +391,8 @@ console.log( getKeys( rules ) );

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

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

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

[@stdlib/_tools/eslint/rules/no-internal-require]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-internal-require
Expand Down
30 changes: 30 additions & 0 deletions lib/node_modules/@stdlib/array/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,18 @@ The namespace exports the following:
- <span class="signature">[`copy( x )`][@stdlib/array/base/copy]</span><span class="delimiter">: </span><span class="description">copy the elements of an array-like object to a new "generic" array.</span>
- <span class="signature">[`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]</span><span class="delimiter">: </span><span class="description">create a filled "generic" array according to a provided callback function.</span>
- <span class="signature">[`filled( value, len )`][@stdlib/array/base/filled]</span><span class="delimiter">: </span><span class="description">create a filled "generic" array.</span>
- <span class="signature">[`flatten( x, shape, colexicographic )`][@stdlib/array/base/flatten]</span><span class="delimiter">: </span><span class="description">flatten an n-dimensional nested array.</span>
- <span class="signature">[`flatten2dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten2d-by]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array according to a callback function.</span>
- <span class="signature">[`flatten2d( x, shape, colexicographic )`][@stdlib/array/base/flatten2d]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array.</span>
- <span class="signature">[`flatten3dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten3d-by]</span><span class="delimiter">: </span><span class="description">flatten a three-dimensional nested array according to a callback function.</span>
- <span class="signature">[`flatten3d( x, shape, colexicographic )`][@stdlib/array/base/flatten3d]</span><span class="delimiter">: </span><span class="description">flatten a three-dimensional nested array.</span>
- <span class="signature">[`flatten4dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten4d-by]</span><span class="delimiter">: </span><span class="description">flatten a four-dimensional nested array according to a callback function.</span>
- <span class="signature">[`flatten4d( x, shape, colexicographic )`][@stdlib/array/base/flatten4d]</span><span class="delimiter">: </span><span class="description">flatten a four-dimensional nested array.</span>
- <span class="signature">[`flatten5dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten5d-by]</span><span class="delimiter">: </span><span class="description">flatten a five-dimensional nested array according to a callback function.</span>
- <span class="signature">[`flatten5d( x, shape, colexicographic )`][@stdlib/array/base/flatten5d]</span><span class="delimiter">: </span><span class="description">flatten a five-dimensional nested array.</span>
- <span class="signature">[`getter( dtype )`][@stdlib/array/base/getter]</span><span class="delimiter">: </span><span class="description">return an accessor function for retrieving an element from an indexed array-like object.</span>
- <span class="signature">[`incrspace( start, stop, increment )`][@stdlib/array/base/incrspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array according to a provided increment.</span>
- <span class="signature">[`last( x )`][@stdlib/array/base/last]</span><span class="delimiter">: </span><span class="description">return the last element of an array-like object.</span>
- <span class="signature">[`linspace( start, stop, length )`][@stdlib/array/base/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array.</span>
- <span class="signature">[`logspace( a, b, length )`][@stdlib/array/base/logspace]</span><span class="delimiter">: </span><span class="description">generate a logarithmically spaced numeric array.</span>
- <span class="signature">[`nCartesianProduct( x1, x2[, ...xN] )`][@stdlib/array/base/n-cartesian-product]</span><span class="delimiter">: </span><span class="description">return the n-fold Cartesian product.</span>
Expand Down Expand Up @@ -138,10 +148,30 @@ console.log( objectKeys( ns ) );

[@stdlib/array/base/filled]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled

[@stdlib/array/base/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten

[@stdlib/array/base/flatten2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d-by

[@stdlib/array/base/flatten2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d

[@stdlib/array/base/flatten3d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d-by

[@stdlib/array/base/flatten3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d

[@stdlib/array/base/flatten4d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d-by

[@stdlib/array/base/flatten4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d

[@stdlib/array/base/flatten5d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by

[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d

[@stdlib/array/base/getter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter

[@stdlib/array/base/incrspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/incrspace

[@stdlib/array/base/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/last

[@stdlib/array/base/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/linspace

[@stdlib/array/base/logspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/logspace
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/nlp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ var fcns = nlp;
- <span class="signature">[`lda( docs, K[, options] )`][@stdlib/nlp/lda]</span><span class="delimiter">: </span><span class="description">latent Dirichlet Allocation via collapsed Gibbs sampling.</span>
- <span class="signature">[`ordinalize( value[, options] )`][@stdlib/nlp/ordinalize]</span><span class="delimiter">: </span><span class="description">convert an integer to an ordinal string (e.g., `1st`, `2nd`, etc.).</span>
- <span class="signature">[`porterStemmer( word )`][@stdlib/nlp/porter-stemmer]</span><span class="delimiter">: </span><span class="description">extract the stem of a given word.</span>
- <span class="signature">[`sentencize( str )`][@stdlib/nlp/sentencize]</span><span class="delimiter">: </span><span class="description">split a string into an array of sentences.</span>
- <span class="signature">[`tokenize( str[, keepWhitespace] )`][@stdlib/nlp/tokenize]</span><span class="delimiter">: </span><span class="description">tokenize a string.</span>

</div>
Expand Down Expand Up @@ -101,6 +102,8 @@ console.log( objectKeys( nlp ) );

[@stdlib/nlp/porter-stemmer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/nlp/porter-stemmer

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

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

<!-- </toc-links> -->
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/object/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The namespace contains the following:

<div class="namespace-toc">

- <span class="signature">[`assign( target, source1[, source2[,...,sourceN]] )`][@stdlib/object/assign]</span><span class="delimiter">: </span><span class="description">copy enumerable own properties from one or more source objects to a target object.</span>
- <span class="signature">[`Object( value )`][@stdlib/object/ctor]</span><span class="delimiter">: </span><span class="description">object constructor.</span>

</div>
Expand Down Expand Up @@ -88,6 +89,8 @@ console.log( objectKeys( ns ) );

<!-- <toc-links> -->

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

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

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