Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -644,6 +644,7 @@ A total of 35 issues were closed in this release:
 
 <details>
 
+-   [`ac2734e`](https://github.com/stdlib-js/stdlib/commit/ac2734ecf26371d363be61dbb4f3448c9cb964d4) - **docs:** address lint errors in TSDoc comments _(by Philipp Burckhardt)_
 -   [`4d90d1a`](https://github.com/stdlib-js/stdlib/commit/4d90d1a8908b2328735f43fccaca8e9a1daffb35) - **docs:** fix example code in TSDoc declarations _(by Philipp Burckhardt)_
 -   [`0eda9b1`](https://github.com/stdlib-js/stdlib/commit/0eda9b1af1d384b1a6be6fe1e80b36a32f69d55c) - **chore:** specify ESLint doctest alias _(by Philipp Burckhardt)_
 -   [`2ffc422`](https://github.com/stdlib-js/stdlib/commit/2ffc422e0a5e583d45776ea7efc359186379bb0c) - **docs:** fix TSDoc return annotation values and example code _(by Philipp Burckhardt)_

base/sub2ind/docs/types/index.d.ts

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable jsdoc/check-param-names */
+
 // TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
@@ -118,7 +120,7 @@ import { ArrayLike } from '@stdlib/types/array';
 * var shape = [ 3, 3, 3 ];
 * var strides = [ 9, 3, 1 ];
 * var offset = 0;
-* var mode = [ 'throw' ]
+* var mode = [ 'throw' ];
 *
 * var idx = sub2ind( shape, strides, offset, 1, 2, 2, mode );
 * // returns 17

dispatch/docs/types/index.d.ts

@@ -16,6 +16,10 @@
 * limitations under the License.
 */
 
+// FIXME: Re-enable `stdlib/tsdoc-declarations-doctest` lint rule once `@stdlib/ndarray/base/ternary`, `@stdlib/ndarray/base/quaternary`, and `@stdlib/ndarray/base/quinary` exist...
+
+/* eslint-disable stdlib/tsdoc-declarations-doctest */
+
 // TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>

fill-slice/docs/types/index.d.ts

@@ -163,7 +163,7 @@ declare function fillSlice<T extends complexndarray>( x: T, value: number | Comp
 * // returns true
 *
 * var arr = ndarray2array( x );
-* // returns [ [ 0, 0, 0, 0, 0, 0, 0, 0 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ] ]
+* // returns [ [ 0, 0, 0, 0 ], [ 0, 0, 5, 5 ], [ 0, 0, 5, 5 ] ]
 *
 * @example
 * var zeros = require( '@stdlib/ndarray/zeros' );
@@ -186,7 +186,7 @@ declare function fillSlice<T extends complexndarray>( x: T, value: number | Comp
 * // returns true
 *
 * var arr = ndarray2array( x );
-* // returns [ [ 0, 0, 0, 0, 0, 0, 0, 0 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ] ]
+* // returns [ [ 0, 0, 0, 0 ], [ 0, 0, 5, 5 ], [ 0, 0, 5, 5 ] ]
 */
 declare function fillSlice<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: U, value: Element<U>, s: MultiSlice | ArrayLike<SliceArgument>, options?: Options ): U;
 
@@ -256,7 +256,7 @@ declare function fillSlice<T = unknown, U extends typedndarray<T> = typedndarray
 * // returns true
 *
 * var arr = ndarray2array( x );
-* // returns [ [ 0, 0, 0, 0, 0, 0, 0, 0 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ] ]
+* // returns [ [ 0, 0, 0, 0 ], [ 0, 0, 5, 5 ], [ 0, 0, 5, 5 ] ]
 *
 * @example
 * var zeros = require( '@stdlib/ndarray/zeros' );
@@ -279,7 +279,7 @@ declare function fillSlice<T = unknown, U extends typedndarray<T> = typedndarray
 * // returns true
 *
 * var arr = ndarray2array( x );
-* // returns [ [ 0, 0, 0, 0, 0, 0, 0, 0 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ], [ 0, 0, 0, 0, 0, 0, 5, 5 ] ]
+* // returns [ [ 0, 0, 0, 0 ], [ 0, 0, 5, 5 ], [ 0, 0, 5, 5 ] ]
 */
 declare function fillSlice<T = unknown, U = unknown>( x: genericndarray<T>, value: U, s: MultiSlice | ArrayLike<SliceArgument>, options?: Options ): genericndarray<T | U>;
 

filter/docs/types/index.d.ts

@@ -1233,7 +1233,7 @@ declare function filter<T = unknown, V = unknown>( x: typedndarray<T>, options:
 * var buffer = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
 * var shape = [ 2, 3 ];
 * var strides = [ 3, 1 ];
-* var offset = 1;
+* var offset = 0;
 *
 * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>
@@ -1269,7 +1269,7 @@ declare function filter<T = unknown, V = unknown>( x: typedndarray<T>, options:
 * var buffer = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
 * var shape = [ 2, 3 ];
 * var strides = [ 3, 1 ];
-* var offset = 1;
+* var offset = 0;
 *
 * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>

flatten-by/docs/types/index.d.ts

@@ -195,11 +195,11 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>
 *
-* var y = flattenBy( x, scale );
+* var y = flattenBy( x, invert );
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ false, true, false, true, false, true ]
+* // returns [ 0, 1, 0, 1, 0, 1 ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
 
@@ -347,11 +347,11 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 *     'depth': 2
 * };
 *
-* var y = flattenBy( x, opts, scale );
+* var y = flattenBy( x, opts, invert );
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ false, true, false, true, false, true ]
+* // returns [ 0, 1, 0, 1, 0, 1 ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
 

reject/docs/types/index.d.ts

@@ -1233,7 +1233,7 @@ declare function reject<T = unknown, V = unknown>( x: typedndarray<T>, options:
 * var buffer = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
 * var shape = [ 2, 3 ];
 * var strides = [ 3, 1 ];
-* var offset = 1;
+* var offset = 0;
 *
 * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>
@@ -1269,7 +1269,7 @@ declare function reject<T = unknown, V = unknown>( x: typedndarray<T>, options:
 * var buffer = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
 * var shape = [ 2, 3 ];
 * var strides = [ 3, 1 ];
-* var offset = 1;
+* var offset = 0;
 *
 * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>