Skip to content

Commit

Permalink
docs: update namespace table of contents
Browse files Browse the repository at this point in the history 
docs: update namespace table of contents 

PR-URL: 	#1102 
Reviewed-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
  • Loading branch information
@stdlib-bot
stdlib-bot authored Sep 22, 2023
1 parent 5768290 commit 4f2310d
Show file tree
Hide file tree
Showing 7 changed files with 140 additions and 6 deletions.
77 changes: 73 additions & 4 deletions lib/node_modules/@stdlib/array/base/README.md
View file

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/assert/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,7 @@ The remaining namespace utilities are as follows:
- <span class="signature">[`isLowercase( value )`][@stdlib/assert/is-lowercase]</span><span class="delimiter">: </span><span class="description">test if a value is a lowercase string.</span>
- <span class="signature">[`isMethodIn( value, property )`][@stdlib/assert/is-method-in]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name, either own or inherited.</span>
- <span class="signature">[`isMethod( value, property )`][@stdlib/assert/is-method]</span><span class="delimiter">: </span><span class="description">test if an object has a specified method name.</span>
- <span class="signature">[`isMultiSlice( value )`][@stdlib/assert/is-multi-slice]</span><span class="delimiter">: </span><span class="description">test if a value is a `MultiSlice`.</span>
- <span class="signature">[`isNamedTypedTupleLike( value )`][@stdlib/assert/is-named-typed-tuple-like]</span><span class="delimiter">: </span><span class="description">test if a value is named typed tuple-like.</span>
- <span class="signature">[`isNativeFunction( value )`][@stdlib/assert/is-native-function]</span><span class="delimiter">: </span><span class="description">test if a value is a native function.</span>
- <span class="signature">[`isNegativeZero( value )`][@stdlib/assert/is-negative-zero]</span><span class="delimiter">: </span><span class="description">test if a value is a number equal to negative zero.</span>
Expand Down Expand Up @@ -455,6 +456,7 @@ The remaining namespace utilities are as follows:
- <span class="signature">[`isSameValueZero( a, b )`][@stdlib/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
- <span class="signature">[`isSameValue( a, b )`][@stdlib/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test if two arguments are the same value.</span>
- <span class="signature">[`isSemVer( value )`][@stdlib/assert/is-semver]</span><span class="delimiter">: </span><span class="description">test if a value is a semantic version string.</span>
- <span class="signature">[`isSlice( value )`][@stdlib/assert/is-slice]</span><span class="delimiter">: </span><span class="description">test if a value is a `Slice`.</span>
- <span class="signature">[`isSnakecase( value )`][@stdlib/assert/is-snakecase]</span><span class="delimiter">: </span><span class="description">test if a value is a string in snake case.</span>
- <span class="signature">[`isStartcase( value )`][@stdlib/assert/is-startcase]</span><span class="delimiter">: </span><span class="description">test if a value is a startcase string.</span>
- <span class="signature">[`isStrictEqual( a, b )`][@stdlib/assert/is-strict-equal]</span><span class="delimiter">: </span><span class="description">test if two arguments are strictly equal.</span>
Expand Down Expand Up @@ -641,6 +643,8 @@ console.log( objectKeys( assert ) );

[@stdlib/assert/is-method]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-method

[@stdlib/assert/is-multi-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-multi-slice

[@stdlib/assert/is-named-typed-tuple-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-named-typed-tuple-like

[@stdlib/assert/is-native-function]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-native-function
Expand Down Expand Up @@ -719,6 +723,8 @@ console.log( objectKeys( assert ) );

[@stdlib/assert/is-semver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-semver

[@stdlib/assert/is-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-slice

[@stdlib/assert/is-snakecase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-snakecase

[@stdlib/assert/is-startcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-startcase
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ var fcns = special;
- <span class="signature">[`log1mexp( x )`][@stdlib/math/base/special/log1mexp]</span><span class="delimiter">: </span><span class="description">evaluates the natural logarithm of `1-exp(-|x|)`.</span>
- <span class="signature">[`log1p( x )`][@stdlib/math/base/special/log1p]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of `1+x`.</span>
- <span class="signature">[`log1pexp( x )`][@stdlib/math/base/special/log1pexp]</span><span class="delimiter">: </span><span class="description">evaluates the natural logarithm of `1+exp(x)`.</span>
- <span class="signature">[`log1pmx( x )`][@stdlib/math/base/special/log1pmx]</span><span class="delimiter">: </span><span class="description">evaluate `ln(1+x) - x`.</span>
- <span class="signature">[`log2( x )`][@stdlib/math/base/special/log2]</span><span class="delimiter">: </span><span class="description">evaluate the binary logarithm.</span>
- <span class="signature">[`logaddexp( x, y )`][@stdlib/math/base/special/logaddexp]</span><span class="delimiter">: </span><span class="description">evaluates the natural logarithm of `exp(x) + exp(y)`.</span>
- <span class="signature">[`pow( base, exponent )`][@stdlib/math/base/special/pow]</span><span class="delimiter">: </span><span class="description">exponential function.</span>
Expand Down Expand Up @@ -810,6 +811,8 @@ console.log( objectKeys( special ) );

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

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

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

[@stdlib/math/base/special/logaddexp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/logaddexp
Expand Down
1 change: 0 additions & 1 deletion lib/node_modules/@stdlib/ndarray/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ In addition, the namespace contains the following multidimensional array utility
- <span class="signature">[`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
- <span class="signature">[`defaults()`][@stdlib/ndarray/defaults]</span><span class="delimiter">: </span><span class="description">default ndarray settings.</span>
- <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
- <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
- <span class="signature">[`ndarrayDataTypes( [kind] )`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
- <span class="signature">[`ndemptyLike( x[, options] )`][@stdlib/ndarray/empty-like]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having the same shape and data type as a provided ndarray.</span>
- <span class="signature">[`ndempty( shape[, options] )`][@stdlib/ndarray/empty]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having a specified shape and data type.</span>
Expand Down
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/slice/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ The namespace contains the following:

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

- <span class="signature">[`base`][@stdlib/slice/base]</span><span class="delimiter">: </span><span class="description">base slice namespace.</span>
- <span class="signature">[`Slice()`][@stdlib/slice/ctor]</span><span class="delimiter">: </span><span class="description">slice constructor.</span>
- <span class="signature">[`MultiSlice( ...slice )`][@stdlib/slice/multi]</span><span class="delimiter">: </span><span class="description">multi-slice constructor.</span>
- <span class="signature">[`seq2slice( str, len, strict )`][@stdlib/slice/seq2slice]</span><span class="delimiter">: </span><span class="description">convert a subsequence string to a `Slice` object.</span>

</div>

<!-- </toc> -->

</section>
Expand Down Expand Up @@ -80,6 +89,18 @@ console.log( objectKeys( ns ) );

<section class="links">

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

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

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

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

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

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

</section>

<!-- /.links -->
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/slice/base/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ The namespace contains the following:

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

- <span class="signature">[`sliceLength( slice )`][@stdlib/slice/base/length]</span><span class="delimiter">: </span><span class="description">compute the number of elements in a normalized slice.</span>
- <span class="signature">[`normalizeMultiSlice( slice, shape, strict )`][@stdlib/slice/base/normalize-multi-slice]</span><span class="delimiter">: </span><span class="description">normalize a `MultiSlice` object.</span>
- <span class="signature">[`normalizeSlice( slice, len, strict )`][@stdlib/slice/base/normalize-slice]</span><span class="delimiter">: </span><span class="description">normalize a `Slice` object.</span>
- <span class="signature">[`seq2multislice( str, shape, strict )`][@stdlib/slice/base/seq2multislice]</span><span class="delimiter">: </span><span class="description">convert a multidimensional subsequence string to a `MultiSlice` object.</span>
- <span class="signature">[`seq2slice( str, len, strict )`][@stdlib/slice/base/seq2slice]</span><span class="delimiter">: </span><span class="description">convert a subsequence string to a `Slice` object.</span>
- <span class="signature">[`sliceShape( slice )`][@stdlib/slice/base/shape]</span><span class="delimiter">: </span><span class="description">compute the shape of a normalized multi-slice.</span>
- <span class="signature">[`slice2seq( str )`][@stdlib/slice/base/slice2seq]</span><span class="delimiter">: </span><span class="description">convert a `Slice` object to a subsequence string.</span>
- <span class="signature">[`str2multislice( str )`][@stdlib/slice/base/str2multislice]</span><span class="delimiter">: </span><span class="description">parse a string-serialized `MultiSlice` object.</span>
- <span class="signature">[`str2slice( str )`][@stdlib/slice/base/str2slice]</span><span class="delimiter">: </span><span class="description">parse a string-serialized `Slice` object.</span>

</div>

<!-- </toc> -->

</section>
Expand Down Expand Up @@ -80,6 +94,28 @@ console.log( objectKeys( ns ) );

<section class="links">

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

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

[@stdlib/slice/base/normalize-multi-slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/normalize-multi-slice

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/string/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The namespace exposes the following string manipulation functions:
- <span class="signature">[`percentEncode( str )`][@stdlib/string/percent-encode]</span><span class="delimiter">: </span><span class="description">percent-encode a UTF-16 encoded string according to RFC 3986.</span>
- <span class="signature">[`prevGraphemeClusterBreak( string[, fromIndex] )`][@stdlib/string/prev-grapheme-cluster-break]</span><span class="delimiter">: </span><span class="description">return the previous extended grapheme cluster break in a string before a specified position.</span>
- <span class="signature">[`removeFirst( str[, n][, options] )`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>
- <span class="signature">[`removeLast( str[, n] )`][@stdlib/string/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last character(s) of a string.</span>
- <span class="signature">[`removeLast( str[, n][, options] )`][@stdlib/string/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last character(s) of a string.</span>
- <span class="signature">[`removePunctuation( str )`][@stdlib/string/remove-punctuation]</span><span class="delimiter">: </span><span class="description">remove punctuation characters from a string.</span>
- <span class="signature">[`removeUTF8BOM( str )`][@stdlib/string/remove-utf8-bom]</span><span class="delimiter">: </span><span class="description">remove a UTF-8 byte order mark (BOM) from the beginning of a string.</span>
- <span class="signature">[`removeWords( str, words[, ignoreCase] )`][@stdlib/string/remove-words]</span><span class="delimiter">: </span><span class="description">remove a list of words from a string.</span>
Expand Down

1 comment on commit 4f2310d

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base $\color{green}762/762$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}762/762$
$\color{green}+100.00\%$
assert $\color{green}2553/2553$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}2553/2553$
$\color{green}+100.00\%$
math/base/special $\color{green}2094/2094$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}2094/2094$
$\color{green}+100.00\%$
ndarray $\color{green}249/249$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}249/249$
$\color{green}+100.00\%$
slice $\color{green}78/78$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}78/78$
$\color{green}+100.00\%$
slice/base $\color{green}123/123$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}123/123$
$\color{green}+100.00\%$
string $\color{green}523/523$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}523/523$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.