Skip to content

Commit 3a0b3cc

Browse files
PlaneshifterPlaneshifter
committed
fix: improve entries return type and examples in array/complex128 types
--- 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 0ea23ed commit 3a0b3cc

File tree

1 file changed

+28
-29
lines changed
  • lib/node_modules/@stdlib/array/complex128/docs/types

1 file changed

+28
-29
lines changed

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

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ declare class Complex128Array implements Complex128ArrayInterface {
312312
* @example
313313
* var ArrayBuffer = require( '@stdlib/array/buffer' );
314314
*
315-
* var buf = new ArrayBuffer( 16 );
315+
* var buf = new ArrayBuffer( 32 );
316316
* var arr = new Complex128Array( buf );
317317
* // returns <Complex128Array>
318318
*
@@ -322,8 +322,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
322322
* @example
323323
* var ArrayBuffer = require( '@stdlib/array/buffer' );
324324
*
325-
* var buf = new ArrayBuffer( 16 );
326-
* var arr = new Complex128Array( buf, 8 );
325+
* var buf = new ArrayBuffer( 32 );
326+
* var arr = new Complex128Array( buf, 16 );
327327
* // returns <Complex128Array>
328328
*
329329
* var len = arr.length;
@@ -332,8 +332,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
332332
* @example
333333
* var ArrayBuffer = require( '@stdlib/array/buffer' );
334334
*
335-
* var buf = new ArrayBuffer( 32 );
336-
* var arr = new Complex128Array( buf, 8, 2 );
335+
* var buf = new ArrayBuffer( 64 );
336+
* var arr = new Complex128Array( buf, 16, 2 );
337337
* // returns <Complex128Array>
338338
*
339339
* var len = arr.length;
@@ -357,8 +357,8 @@ declare class Complex128Array implements Complex128ArrayInterface {
357357
* arr.set( [ 1.0, -1.0 ], 0 );
358358
* arr.set( [ 9.0, -9.0 ], 9 );
359359
*
360-
* z = arr.get( -1 )
361-
* // return <Complex128>
360+
* z = arr.at( -1 );
361+
* // returns <Complex128>
362362
*
363363
* z = arr.at( 100 );
364364
* // returns undefined
@@ -489,7 +489,7 @@ declare class Complex128Array implements Complex128ArrayInterface {
489489
* var bool = it.next().done;
490490
* // returns true
491491
*/
492-
entries(): Iterator;
492+
entries(): TypedIterator<[number, Complex128]>;
493493

494494
/**
495495
* Tests whether all elements in an array pass a test implemented by a predicate function.
@@ -728,9 +728,6 @@ declare class Complex128Array implements Complex128ArrayInterface {
728728
* arr.set( [ 3.0, 3.0 ], 2 );
729729
*
730730
* arr.forEach( log );
731-
* // => 0: 1 + 1i
732-
* // => 1: 2 + 2i
733-
* // => 2: 3 + 3i
734731
*/
735732
forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
736733

@@ -799,13 +796,13 @@ declare class Complex128Array implements Complex128ArrayInterface {
799796
* arr.set( [ 2.0, 2.0 ], 3 );
800797
* arr.set( [ 5.0, 5.0 ], 4 );
801798
*
802-
* var idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ) );
799+
* var idx = arr.indexOf( new Complex128( 2.0, 2.0 ) );
803800
* // returns 1
804801
*
805-
* idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ), 2 );
802+
* idx = arr.indexOf( new Complex128( 2.0, 2.0 ), 2 );
806803
* // returns 3
807804
*
808-
* idx = arr.indexOf( new Complex128( [ 2.0, 2.0 ] ), -3 );
805+
* idx = arr.indexOf( new Complex128( 2.0, 2.0 ), -3 );
809806
* // returns 3
810807
*/
811808
indexOf( searchElement: ComplexLike, fromIndex?: number ): number;
@@ -1592,7 +1589,7 @@ interface Complex128ArrayConstructor {
15921589
* @example
15931590
* var ArrayBuffer = require( '@stdlib/array/buffer' );
15941591
*
1595-
* var buf = new ArrayBuffer( 16 );
1592+
* var buf = new ArrayBuffer( 32 );
15961593
* var arr = new Complex128Array( buf );
15971594
* // returns <Complex128Array>
15981595
*
@@ -1602,8 +1599,8 @@ interface Complex128ArrayConstructor {
16021599
* @example
16031600
* var ArrayBuffer = require( '@stdlib/array/buffer' );
16041601
*
1605-
* var buf = new ArrayBuffer( 16 );
1606-
* var arr = new Complex128Array( buf, 8 );
1602+
* var buf = new ArrayBuffer( 32 );
1603+
* var arr = new Complex128Array( buf, 16 );
16071604
* // returns <Complex128Array>
16081605
*
16091606
* var len = arr.length;
@@ -1612,8 +1609,8 @@ interface Complex128ArrayConstructor {
16121609
* @example
16131610
* var ArrayBuffer = require( '@stdlib/array/buffer' );
16141611
*
1615-
* var buf = new ArrayBuffer( 32 );
1616-
* var arr = new Complex128Array( buf, 8, 2 );
1612+
* var buf = new ArrayBuffer( 64 );
1613+
* var arr = new Complex128Array( buf, 16, 2 );
16171614
* // returns <Complex128Array>
16181615
*
16191616
* var len = arr.length;
@@ -1661,7 +1658,7 @@ interface Complex128ArrayConstructor {
16611658
* @example
16621659
* var ArrayBuffer = require( '@stdlib/array/buffer' );
16631660
*
1664-
* var buf = new ArrayBuffer( 16 );
1661+
* var buf = new ArrayBuffer( 32 );
16651662
* var arr = new Complex128Array( buf );
16661663
* // returns <Complex128Array>
16671664
*
@@ -1671,8 +1668,8 @@ interface Complex128ArrayConstructor {
16711668
* @example
16721669
* var ArrayBuffer = require( '@stdlib/array/buffer' );
16731670
*
1674-
* var buf = new ArrayBuffer( 16 );
1675-
* var arr = new Complex128Array( buf, 8 );
1671+
* var buf = new ArrayBuffer( 32 );
1672+
* var arr = new Complex128Array( buf, 16 );
16761673
* // returns <Complex128Array>
16771674
*
16781675
* var len = arr.length;
@@ -1681,8 +1678,8 @@ interface Complex128ArrayConstructor {
16811678
* @example
16821679
* var ArrayBuffer = require( '@stdlib/array/buffer' );
16831680
*
1684-
* var buf = new ArrayBuffer( 32 );
1685-
* var arr = new Complex128Array( buf, 8, 2 );
1681+
* var buf = new ArrayBuffer( 64 );
1682+
* var arr = new Complex128Array( buf, 16, 2 );
16861683
* // returns <Complex128Array>
16871684
*
16881685
* var len = arr.length;
@@ -1808,7 +1805,7 @@ interface Complex128ArrayConstructor {
18081805
* @example
18091806
* var ArrayBuffer = require( '@stdlib/array/buffer' );
18101807
*
1811-
* var buf = new ArrayBuffer( 16 );
1808+
* var buf = new ArrayBuffer( 32 );
18121809
* var arr = new Complex128Array( buf );
18131810
* // returns <Complex128Array>
18141811
*
@@ -1818,8 +1815,8 @@ interface Complex128ArrayConstructor {
18181815
* @example
18191816
* var ArrayBuffer = require( '@stdlib/array/buffer' );
18201817
*
1821-
* var buf = new ArrayBuffer( 16 );
1822-
* var arr = new Complex128Array( buf, 8 );
1818+
* var buf = new ArrayBuffer( 32 );
1819+
* var arr = new Complex128Array( buf, 16 );
18231820
* // returns <Complex128Array>
18241821
*
18251822
* var len = arr.length;
@@ -1828,8 +1825,8 @@ interface Complex128ArrayConstructor {
18281825
* @example
18291826
* var ArrayBuffer = require( '@stdlib/array/buffer' );
18301827
*
1831-
* var buf = new ArrayBuffer( 32 );
1832-
* var arr = new Complex128Array( buf, 8, 2 );
1828+
* var buf = new ArrayBuffer( 64 );
1829+
* var arr = new Complex128Array( buf, 16, 2 );
18331830
* // returns <Complex128Array>
18341831
*
18351832
* var len = arr.length;
@@ -1841,3 +1838,5 @@ declare var ctor: Complex128ArrayConstructor;
18411838
// EXPORTS //
18421839

18431840
export = ctor;
1841+
1842+
// eslint-doctest-alias: Complex128Array

0 commit comments

Comments
 (0)