Skip to content

Commit 68446dc

Browse files
stdlib-botstdlib-bot
authored
docs: update namespace table of contents
PR-URL: stdlib-js#9848 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent f4988cf commit 68446dc

File tree

7 files changed

+98
-44
lines changed

7 files changed

+98
-44
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ var eslint = rules;
7272
- <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>
7373
- <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>
7474
- <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>
75+
- <span class="signature">[`no-empty-lines-between-requires`][@stdlib/_tools/eslint/rules/no-empty-lines-between-requires]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce no empty lines between module-level require statements.</span>
7576
- <span class="signature">[`no-error-string-concat`][@stdlib/_tools/eslint/rules/no-error-string-concat]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing string concatenation in error messages.</span>
7677
- <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>
7778
- <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>
@@ -417,6 +418,8 @@ console.log( getKeys( rules ) );
417418

418419
[@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
419420

421+
[@stdlib/_tools/eslint/rules/no-empty-lines-between-requires]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-empty-lines-between-requires
422+
420423
[@stdlib/_tools/eslint/rules/no-error-string-concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/no-error-string-concat
421424

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

‎lib/node_modules/@stdlib/complex/float64/base/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ The namespace contains the following functions:
5858
<div class="namespace-toc">
5959

6060
- <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float64/base/add]</span><span class="delimiter">: </span><span class="description">add two double-precision complex floating-point numbers.</span>
61+
- <span class="signature">[`add3( z1, z2, z3 )`][@stdlib/complex/float64/base/add3]</span><span class="delimiter">: </span><span class="description">compute the sum of three double-precision complex floating-point numbers.</span>
6162
- <span class="signature">[`div( z1, z2 )`][@stdlib/complex/float64/base/div]</span><span class="delimiter">: </span><span class="description">divide two double-precision complex floating-point numbers.</span>
6263
- <span class="signature">[`identity( z )`][@stdlib/complex/float64/base/identity]</span><span class="delimiter">: </span><span class="description">evaluate the identity function of a double-precision complex floating-point number.</span>
6364
- <span class="signature">[`muladd( alpha, x, y )`][@stdlib/complex/float64/base/mul-add]</span><span class="delimiter">: </span><span class="description">perform a multiply-add operation involving three double-precision complex floating-point numbers.</span>
@@ -117,6 +118,8 @@ console.log( objectKeys( ns ) );
117118

118119
[@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add
119120

121+
[@stdlib/complex/float64/base/add3]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add3
122+
120123
[@stdlib/complex/float64/base/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/div
121124

122125
[@stdlib/complex/float64/base/identity]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/identity

‎lib/node_modules/@stdlib/ndarray/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ In addition, the namespace contains the following multidimensional array utility
7777
- <span class="signature">[`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape.</span>
7878
- <span class="signature">[`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
7979
- <span class="signature">[`castingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
80-
- <span class="signature">[`concat( arrays[, dim] )`][@stdlib/ndarray/concat]</span><span class="delimiter">: </span><span class="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
80+
- <span class="signature">[`concat( arrays[, options] )`][@stdlib/ndarray/concat]</span><span class="delimiter">: </span><span class="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
8181
- <span class="signature">[`copy( x[, options] )`][@stdlib/ndarray/copy]</span><span class="delimiter">: </span><span class="description">copy an input ndarray to a new ndarray having the same shape and data type.</span>
8282
- <span class="signature">[`countFalsy( x[, options] )`][@stdlib/ndarray/count-falsy]</span><span class="delimiter">: </span><span class="description">count the number of falsy elements along one or more `ndarray` dimensions.</span>
8383
- <span class="signature">[`countIf( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/count-if]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements along one or more `ndarray` dimensions.</span>

0 commit comments

Comments
 (0)