Skip to content

Commit bf4e05f

Browse files
stdlib-botkgryte
andauthored
docs: update namespace table of contents
PR-URL: #1078 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent a9e7f23 commit bf4e05f

File tree

6 files changed

+51
-3
lines changed

6 files changed

+51
-3
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ var eslint = rules;
5656
- <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>
5757
- <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>
5858
- <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>
59+
- <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>
5960
- <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>
6061
- <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>
6162
- <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>
@@ -65,6 +66,7 @@ var eslint = rules;
6566
- <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>
6667
- <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>
6768
- <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>
69+
- <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>
6870
- <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>
6971
- <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>
7072
- <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>
@@ -143,12 +145,14 @@ var eslint = rules;
143145
- <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>
144146
- <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>
145147
- <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>
148+
- <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>
146149
- <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>
147150
- <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>
148151
- <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>
149152
- <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>
150153
- <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>
151154
- <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>
155+
- <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>
152156
- <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>
153157
- <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>
154158
- <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>
@@ -305,6 +309,8 @@ console.log( getKeys( rules ) );
305309

306310
[@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
307311

312+
[@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
313+
308314
[@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
309315

310316
[@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
@@ -317,6 +323,8 @@ console.log( getKeys( rules ) );
317323

318324
[@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
319325

326+
[@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
327+
320328
[@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
321329

322330
[@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
@@ -363,6 +371,8 @@ console.log( getKeys( rules ) );
363371

364372
[@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
365373

374+
[@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
375+
366376
[@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
367377

368378
[@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
@@ -381,6 +391,8 @@ console.log( getKeys( rules ) );
381391

382392
[@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
383393

394+
[@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
395+
384396
[@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
385397

386398
[@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

lib/node_modules/@stdlib/array/base/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,18 @@ The namespace exports the following:
5858
- <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>
5959
- <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>
6060
- <span class="signature">[`filled( value, len )`][@stdlib/array/base/filled]</span><span class="delimiter">: </span><span class="description">create a filled "generic" array.</span>
61+
- <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>
62+
- <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>
63+
- <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>
64+
- <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>
65+
- <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>
66+
- <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>
67+
- <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>
68+
- <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>
69+
- <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>
6170
- <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>
6271
- <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>
72+
- <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>
6373
- <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>
6474
- <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>
6575
- <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>
@@ -138,10 +148,30 @@ console.log( objectKeys( ns ) );
138148

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

151+
[@stdlib/array/base/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten
152+
153+
[@stdlib/array/base/flatten2d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d-by
154+
155+
[@stdlib/array/base/flatten2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten2d
156+
157+
[@stdlib/array/base/flatten3d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d-by
158+
159+
[@stdlib/array/base/flatten3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d
160+
161+
[@stdlib/array/base/flatten4d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d-by
162+
163+
[@stdlib/array/base/flatten4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d
164+
165+
[@stdlib/array/base/flatten5d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by
166+
167+
[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d
168+
141169
[@stdlib/array/base/getter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter
142170

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

173+
[@stdlib/array/base/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/last
174+
145175
[@stdlib/array/base/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/linspace
146176

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

lib/node_modules/@stdlib/nlp/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ var fcns = nlp;
4848
- <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>
4949
- <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>
5050
- <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>
51+
- <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>
5152
- <span class="signature">[`tokenize( str[, keepWhitespace] )`][@stdlib/nlp/tokenize]</span><span class="delimiter">: </span><span class="description">tokenize a string.</span>
5253

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

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

105+
[@stdlib/nlp/sentencize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/nlp/sentencize
106+
104107
[@stdlib/nlp/tokenize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/nlp/tokenize
105108

106109
<!-- </toc-links> -->

lib/node_modules/@stdlib/object/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ The namespace contains the following:
4545

4646
<div class="namespace-toc">
4747

48+
- <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>
4849
- <span class="signature">[`Object( value )`][@stdlib/object/ctor]</span><span class="delimiter">: </span><span class="description">object constructor.</span>
4950

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

8990
<!-- <toc-links> -->
9091

92+
[@stdlib/object/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/assign
93+
9194
[@stdlib/object/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/ctor
9295

9396
<!-- </toc-links> -->

0 commit comments

Comments
 (0)