From 9b643892f89b3ed2381012d9fc2fb9c67bd83697 Mon Sep 17 00:00:00 2001 From: kgryte Date: Fri, 4 Aug 2023 16:16:16 +0000 Subject: [PATCH] docs: update namespace table of contents --- .../@stdlib/_tools/eslint/rules/README.md | 12 ++++++++ lib/node_modules/@stdlib/array/base/README.md | 30 +++++++++++++++++++ lib/node_modules/@stdlib/nlp/README.md | 3 ++ lib/node_modules/@stdlib/object/README.md | 3 ++ lib/node_modules/@stdlib/stats/README.md | 4 +-- lib/node_modules/@stdlib/string/README.md | 2 +- 6 files changed, 51 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md index 73334d11f7b..f28481d7955 100644 --- a/lib/node_modules/@stdlib/_tools/eslint/rules/README.md +++ b/lib/node_modules/@stdlib/_tools/eslint/rules/README.md @@ -56,6 +56,7 @@ var eslint = rules; - [`doctest-quote-props`][@stdlib/_tools/eslint/rules/doctest-quote-props]: ESLint rule to enforce that property names in return annotations are quoted using single quotes. - [`doctest`][@stdlib/_tools/eslint/rules/doctest]: ESLint rule to ensure return annotations match the actual output. - [`empty-line-before-comment`][@stdlib/_tools/eslint/rules/empty-line-before-comment]: ESLint rule to enforce empty lines before comments. +- [`first-unit-test`][@stdlib/_tools/eslint/rules/first-unit-test]: ESLint rule to enforce that a tape file starts with the expected test. - [`module-exports-last`][@stdlib/_tools/eslint/rules/module-exports-last]: ESLint rule enforcing that export statements appear at the end of a file. - [`namespace-export-all`][@stdlib/_tools/eslint/rules/namespace-export-all]: ESLint rule to enforce that a namespace `index.js` exports all packages in the respective namespace directory. - [`namespace-index-order`][@stdlib/_tools/eslint/rules/namespace-index-order]: ESLint rule to enforce that modules in a namespace `index.js` file are listed in alphabetical order according to module name. @@ -65,6 +66,7 @@ var eslint = rules; - [`no-builtin-math`][@stdlib/_tools/eslint/rules/no-builtin-math]: ESLint rule enforcing that `stdlib` equivalents are used instead of the built-in global `Math` object. - [`no-dynamic-exports`][@stdlib/_tools/eslint/rules/no-dynamic-exports]: ESLint rule enforcing that only statically analyzable values are exported. - [`no-dynamic-require`][@stdlib/_tools/eslint/rules/no-dynamic-require]: ESLint rule enforcing that `require()` calls have only string literals as arguments. +- [`no-empty-comments`][@stdlib/_tools/eslint/rules/no-empty-comments]: ESLint rule to disallow empty comments. - [`no-immediate-require`][@stdlib/_tools/eslint/rules/no-immediate-require]: ESLint rule enforcing that `require()` expressions are not immediately invoked. - [`no-internal-require`][@stdlib/_tools/eslint/rules/no-internal-require]: ESLint rule disallowing `require()` calls into internals of another stdlib package. - [`no-multiple-empty-lines`][@stdlib/_tools/eslint/rules/no-multiple-empty-lines]: ESLint rule to enforce that that code does not contain multiple blank lines. @@ -143,12 +145,14 @@ var eslint = rules; - [`jsdoc-no-inline-padding`][@stdlib/_tools/eslint/rules/jsdoc-no-inline-padding]: ESLint rule to prevent padding of Markdown inline nodes between their markers and content in JSDoc descriptions. - [`jsdoc-no-literal-urls`][@stdlib/_tools/eslint/rules/jsdoc-no-literal-urls]: ESLint rule to prevent URLs without angle-brackets from being used in JSDoc descriptions. - [`jsdoc-no-missing-blank-lines`][@stdlib/_tools/eslint/rules/jsdoc-no-missing-blank-lines]: ESLint rule to require blank lines between Markdown block nodes in JSDoc descriptions. +- [`jsdoc-no-multiple-blank-lines`][@stdlib/_tools/eslint/rules/jsdoc-no-multiple-blank-lines]: ESLint rule to prevent multiple blank lines in JSDoc comments. - [`jsdoc-no-multiple-toplevel-headings`][@stdlib/_tools/eslint/rules/jsdoc-no-multiple-toplevel-headings]: ESLint rule to prevent multiple top-level Markdown headings from being used in JSDoc descriptions. - [`jsdoc-no-paragraph-content-indent`][@stdlib/_tools/eslint/rules/jsdoc-no-paragraph-content-indent]: ESLint rule to prevent indentation of Markdown paragraph content in JSDoc descriptions. - [`jsdoc-no-reference-like-url`][@stdlib/_tools/eslint/rules/jsdoc-no-reference-like-url]: ESLint rule to prevent Markdown references from being used like URLs in JSDoc descriptions. - [`jsdoc-no-shell-dollars`][@stdlib/_tools/eslint/rules/jsdoc-no-shell-dollars]: ESLint rule to prevent shell code in Markdown fenced code blocks from being prefixed by dollar-characters in JSDoc descriptions. - [`jsdoc-no-shortcut-reference-image`][@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-image]: ESLint rule to prevent shortcut Markdown reference images from being used in JSDoc descriptions. - [`jsdoc-no-shortcut-reference-link`][@stdlib/_tools/eslint/rules/jsdoc-no-shortcut-reference-link]: ESLint rule to prevent shortcut Markdown reference links from being used in JSDoc descriptions. +- [`jsdoc-no-space-aligned-asterisks`][@stdlib/_tools/eslint/rules/jsdoc-no-space-aligned-asterisks]: ESLint rule to disallow space-aligned asterisks for JSDoc comments. - [`jsdoc-no-table-indentation`][@stdlib/_tools/eslint/rules/jsdoc-no-table-indentation]: ESLint rule to prevent unnecessary indentation of Markdown tables in JSDoc descriptions. - [`jsdoc-no-tabs`][@stdlib/_tools/eslint/rules/jsdoc-no-tabs]: ESLint rule forbidding the use of tabs in JSDoc descriptions. - [`jsdoc-no-undefined-references`][@stdlib/_tools/eslint/rules/jsdoc-no-undefined-references]: ESLint rule to prevent references to undefined Markdown definitions in JSDoc descriptions. @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/lib/node_modules/@stdlib/array/base/README.md b/lib/node_modules/@stdlib/array/base/README.md index 16f923b4b39..597946381db 100644 --- a/lib/node_modules/@stdlib/array/base/README.md +++ b/lib/node_modules/@stdlib/array/base/README.md @@ -58,8 +58,18 @@ The namespace exports the following: - [`copy( x )`][@stdlib/array/base/copy]: copy the elements of an array-like object to a new "generic" array. - [`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]: create a filled "generic" array according to a provided callback function. - [`filled( value, len )`][@stdlib/array/base/filled]: create a filled "generic" array. +- [`flatten( x, shape, colexicographic )`][@stdlib/array/base/flatten]: flatten an n-dimensional nested array. +- [`flatten2dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten2d-by]: flatten a two-dimensional nested array according to a callback function. +- [`flatten2d( x, shape, colexicographic )`][@stdlib/array/base/flatten2d]: flatten a two-dimensional nested array. +- [`flatten3dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten3d-by]: flatten a three-dimensional nested array according to a callback function. +- [`flatten3d( x, shape, colexicographic )`][@stdlib/array/base/flatten3d]: flatten a three-dimensional nested array. +- [`flatten4dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten4d-by]: flatten a four-dimensional nested array according to a callback function. +- [`flatten4d( x, shape, colexicographic )`][@stdlib/array/base/flatten4d]: flatten a four-dimensional nested array. +- [`flatten5dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten5d-by]: flatten a five-dimensional nested array according to a callback function. +- [`flatten5d( x, shape, colexicographic )`][@stdlib/array/base/flatten5d]: flatten a five-dimensional nested array. - [`getter( dtype )`][@stdlib/array/base/getter]: return an accessor function for retrieving an element from an indexed array-like object. - [`incrspace( start, stop, increment )`][@stdlib/array/base/incrspace]: generate a linearly spaced numeric array according to a provided increment. +- [`last( x )`][@stdlib/array/base/last]: return the last element of an array-like object. - [`linspace( start, stop, length )`][@stdlib/array/base/linspace]: generate a linearly spaced numeric array. - [`logspace( a, b, length )`][@stdlib/array/base/logspace]: generate a logarithmically spaced numeric array. - [`nCartesianProduct( x1, x2[, ...xN] )`][@stdlib/array/base/n-cartesian-product]: return the n-fold Cartesian product. @@ -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 diff --git a/lib/node_modules/@stdlib/nlp/README.md b/lib/node_modules/@stdlib/nlp/README.md index c65523a9804..bb606b3c72a 100644 --- a/lib/node_modules/@stdlib/nlp/README.md +++ b/lib/node_modules/@stdlib/nlp/README.md @@ -48,6 +48,7 @@ var fcns = nlp; - [`lda( docs, K[, options] )`][@stdlib/nlp/lda]: latent Dirichlet Allocation via collapsed Gibbs sampling. - [`ordinalize( value[, options] )`][@stdlib/nlp/ordinalize]: convert an integer to an ordinal string (e.g., `1st`, `2nd`, etc.). - [`porterStemmer( word )`][@stdlib/nlp/porter-stemmer]: extract the stem of a given word. +- [`sentencize( str )`][@stdlib/nlp/sentencize]: split a string into an array of sentences. - [`tokenize( str[, keepWhitespace] )`][@stdlib/nlp/tokenize]: tokenize a string. @@ -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 diff --git a/lib/node_modules/@stdlib/object/README.md b/lib/node_modules/@stdlib/object/README.md index 0bbc720440e..368b35b356a 100644 --- a/lib/node_modules/@stdlib/object/README.md +++ b/lib/node_modules/@stdlib/object/README.md @@ -45,6 +45,7 @@ The namespace contains the following:
+- [`assign( target, source1[, source2[,...,sourceN]] )`][@stdlib/object/assign]: copy enumerable own properties from one or more source objects to a target object. - [`Object( value )`][@stdlib/object/ctor]: object constructor.
@@ -88,6 +89,8 @@ console.log( objectKeys( ns ) ); +[@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 diff --git a/lib/node_modules/@stdlib/stats/README.md b/lib/node_modules/@stdlib/stats/README.md index 8d8865fcc27..24ce9711d2a 100644 --- a/lib/node_modules/@stdlib/stats/README.md +++ b/lib/node_modules/@stdlib/stats/README.md @@ -48,8 +48,8 @@ The namespace exposes the following statistical tests: - [`anova1( x, factor[, opts] )`][@stdlib/stats/anova1]: perform a one-way analysis of variance. - [`bartlettTest( a[,b,...,k][, opts] )`][@stdlib/stats/bartlett-test]: compute Bartlett’s test for equal variances. - [`binomialTest( x[, n][, opts] )`][@stdlib/stats/binomial-test]: exact test for the success probability in a Bernoulli experiment. -- [`chi2gof( x, y[, ...args][, opts] )`][@stdlib/stats/chi2gof]: perform a chi-square goodness-of-fit test. -- [`chi2test( x[, opts] )`][@stdlib/stats/chi2test]: perform a chi-square independence test. +- [`chi2gof( x, y[, ...args][, options] )`][@stdlib/stats/chi2gof]: perform a chi-square goodness-of-fit test. +- [`chi2test( x[, options] )`][@stdlib/stats/chi2test]: perform a chi-square independence test. - [`flignerTest( a[,b,...,k][, opts] )`][@stdlib/stats/fligner-test]: compute the Fligner-Killeen test for equal variances. - [`kruskalTest( a[,b,...,k][, opts] )`][@stdlib/stats/kruskal-test]: compute the Kruskal-Wallis test for equal medians. - [`kstest( x, y[, ...params][, opts] )`][@stdlib/stats/kstest]: one-sample Kolmogorov-Smirnov goodness-of-fit test. diff --git a/lib/node_modules/@stdlib/string/README.md b/lib/node_modules/@stdlib/string/README.md index 83427a6b181..4a438a5998a 100644 --- a/lib/node_modules/@stdlib/string/README.md +++ b/lib/node_modules/@stdlib/string/README.md @@ -70,7 +70,7 @@ The namespace exposes the following string manipulation functions: - [`pascalcase( str )`][@stdlib/string/pascalcase]: convert a string to Pascal case. - [`percentEncode( str )`][@stdlib/string/percent-encode]: percent-encode a UTF-16 encoded string according to RFC 3986. - [`prevGraphemeClusterBreak( string[, fromIndex] )`][@stdlib/string/prev-grapheme-cluster-break]: return the previous extended grapheme cluster break in a string before a specified position. -- [`removeFirst( str[, n] )`][@stdlib/string/remove-first]: remove the first character(s) of a string. +- [`removeFirst( str[, n][, options] )`][@stdlib/string/remove-first]: remove the first character(s) of a string. - [`removeLast( str[, n] )`][@stdlib/string/remove-last]: remove the last character(s) of a string. - [`removePunctuation( str )`][@stdlib/string/remove-punctuation]: remove punctuation characters from a string. - [`removeUTF8BOM( str )`][@stdlib/string/remove-utf8-bom]: remove a UTF-8 byte order mark (BOM) from the beginning of a string.