Skip to content

Commit c520b5a

Browse files
committed
docs: address TSDoc lint errors and add doctest aliases
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 3f7b1ed commit c520b5a

File tree

7 files changed

+20
-14
lines changed

7 files changed

+20
-14
lines changed

lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ declare class Complex64Array implements Complex64ArrayInterface {
357357
* arr.set( [ 1.0, -1.0 ], 0 );
358358
* arr.set( [ 9.0, -9.0 ], 9 );
359359
*
360-
* z = arr.get( -1 )
361-
* // return <Complex64>
360+
* z = arr.at( -1 );
361+
* // returns <Complex64>
362362
*
363363
* z = arr.at( 100 );
364364
* // returns undefined
@@ -732,9 +732,6 @@ declare class Complex64Array implements Complex64ArrayInterface {
732732
* arr.set( [ 3.0, 3.0 ], 2 );
733733
*
734734
* arr.forEach( log );
735-
* // => 0: 1 + 1i
736-
* // => 1: 2 + 2i
737-
* // => 2: 3 + 3i
738735
*/
739736
forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
740737

@@ -801,13 +798,13 @@ declare class Complex64Array implements Complex64ArrayInterface {
801798
* arr.set( [ 2.0, 2.0 ], 3 );
802799
* arr.set( [ 5.0, 5.0 ], 4 );
803800
*
804-
* var idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ) );
801+
* var idx = arr.indexOf( new Complex64( 2.0, 2.0 ) );
805802
* // returns 1
806803
*
807-
* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), 2 );
804+
* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), 2 );
808805
* // returns 3
809806
*
810-
* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), -3 );
807+
* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), -3 );
811808
* // returns 3
812809
*/
813810
indexOf( searchElement: ComplexLike, fromIndex?: number ): number;
@@ -1843,3 +1840,5 @@ declare var ctor: Complex64ArrayConstructor;
18431840
// EXPORTS //
18441841

18451842
export = ctor;
1843+
1844+
// eslint-doctest-alias: Complex64Array

lib/node_modules/@stdlib/array/index/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,3 +323,5 @@ declare var ctor: Constructor;
323323
// EXPORTS //
324324

325325
export = ctor;
326+
327+
// eslint-doctest-alias: ArrayIndex

lib/node_modules/@stdlib/blas/ext/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ interface Namespace {
193193
*
194194
* var x = array( [ -1.0, 2.0, -3.0 ] );
195195
*
196-
* var y = ns.indexOf( x, 2.0 );
196+
* var y = ns.indexOf( x, 2.0, 0 );
197197
* // returns <ndarray>
198198
*
199199
* var idx = y.get();
@@ -203,19 +203,19 @@ interface Namespace {
203203
* var zeros = require( '@stdlib/ndarray/zeros' );
204204
* var array = require( '@stdlib/ndarray/array' );
205205
*
206-
* var x = array( [ -1.0, 2.0, -3.0 ] );
207-
* var y = zeros( x, {
206+
* var x = array( [ -1.0, 2.0, -3.0, 2.0, -5.0, 6.0 ] );
207+
* var y = zeros( [], {
208208
* 'dtype': 'int32'
209209
* } );
210210
*
211-
* var out = ns.indexOf.assign( x, 2.0, y );
211+
* var out = ns.indexOf.assign( x, 2.0, 2, y );
212212
* // returns <ndarray>
213213
*
214214
* var bool = ( out === y );
215215
* // returns true
216216
*
217217
* var idx = out.get();
218-
* // returns 1
218+
* // returns 3
219219
*/
220220
indexOf: typeof indexOf;
221221

lib/node_modules/@stdlib/ndarray/base/unary-reduce-strided1d-dispatch-by/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,7 @@ interface UnaryStrided1dDispatchByConstructor {
551551
*/
552552
declare var ctor: UnaryStrided1dDispatchByConstructor;
553553

554+
// eslint-doctest-alias: UnaryStrided1dDispatchBy
554555

555556
// EXPORTS //
556557

lib/node_modules/@stdlib/ndarray/base/unary-reduce-strided1d-dispatch/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,8 @@ interface UnaryStrided1dDispatchConstructor {
393393
*/
394394
declare var ctor: UnaryStrided1dDispatchConstructor;
395395

396+
// eslint-doctest-alias: UnaryStrided1dDispatch
397+
396398

397399
// EXPORTS //
398400

lib/node_modules/@stdlib/ndarray/base/unary-strided1d-dispatch/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,8 @@ interface UnaryStrided1dDispatchConstructor {
409409
*/
410410
declare var ctor: UnaryStrided1dDispatchConstructor;
411411

412+
// eslint-doctest-alias: UnaryStrided1dDispatch
413+
412414

413415
// EXPORTS //
414416

lib/node_modules/@stdlib/ndarray/slice-from/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* limitations under the License.
1717
*/
1818

19-
/* eslint-disable max-lines */
19+
/* eslint-disable max-lines, jsdoc/check-param-names */
2020

2121
// TypeScript Version: 4.1
2222

0 commit comments

Comments
 (0)