Skip to content

Commit a8ebe24

Browse files
committed
docs: fix accessor example arguments in array/base/arraylike2object
--- 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 03405cc commit a8ebe24

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

  • lib/node_modules/@stdlib/array/base/arraylike2object/docs/types

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ interface GetSetAccessorObject<T> {
650650
* var fcns = obj.accessors;
651651
* // returns [ <Function>, <Function> ]
652652
*
653-
* var v = fcns[ 0 ]( x.data, 2 );
653+
* var v = fcns[ 0 ]( x, 2 );
654654
* // returns 3
655655
*/
656656
declare function arraylike2object( x: Float64Array ): Float64AccessorObject;
@@ -678,7 +678,7 @@ declare function arraylike2object( x: Float64Array ): Float64AccessorObject;
678678
* var fcns = obj.accessors;
679679
* // returns [ <Function>, <Function> ]
680680
*
681-
* var v = fcns[ 0 ]( x.data, 2 );
681+
* var v = fcns[ 0 ]( x, 2 );
682682
* // returns 3
683683
*/
684684
declare function arraylike2object( x: Float32Array ): Float32AccessorObject;
@@ -706,7 +706,7 @@ declare function arraylike2object( x: Float32Array ): Float32AccessorObject;
706706
* var fcns = obj.accessors;
707707
* // returns [ <Function>, <Function> ]
708708
*
709-
* var v = fcns[ 0 ]( x.data, 2 );
709+
* var v = fcns[ 0 ]( x, 2 );
710710
* // returns 3
711711
*/
712712
declare function arraylike2object( x: Int32Array ): Int32AccessorObject;
@@ -734,7 +734,7 @@ declare function arraylike2object( x: Int32Array ): Int32AccessorObject;
734734
* var fcns = obj.accessors;
735735
* // returns [ <Function>, <Function> ]
736736
*
737-
* var v = fcns[ 0 ]( x.data, 2 );
737+
* var v = fcns[ 0 ]( x, 2 );
738738
* // returns 3
739739
*/
740740
declare function arraylike2object( x: Int16Array ): Int16AccessorObject;
@@ -762,7 +762,7 @@ declare function arraylike2object( x: Int16Array ): Int16AccessorObject;
762762
* var fcns = obj.accessors;
763763
* // returns [ <Function>, <Function> ]
764764
*
765-
* var v = fcns[ 0 ]( x.data, 2 );
765+
* var v = fcns[ 0 ]( x, 2 );
766766
* // returns 3
767767
*/
768768
declare function arraylike2object( x: Int8Array ): Int8AccessorObject;
@@ -790,7 +790,7 @@ declare function arraylike2object( x: Int8Array ): Int8AccessorObject;
790790
* var fcns = obj.accessors;
791791
* // returns [ <Function>, <Function> ]
792792
*
793-
* var v = fcns[ 0 ]( x.data, 2 );
793+
* var v = fcns[ 0 ]( x, 2 );
794794
* // returns 3
795795
*/
796796
declare function arraylike2object( x: Uint32Array ): Uint32AccessorObject;
@@ -818,7 +818,7 @@ declare function arraylike2object( x: Uint32Array ): Uint32AccessorObject;
818818
* var fcns = obj.accessors;
819819
* // returns [ <Function>, <Function> ]
820820
*
821-
* var v = fcns[ 0 ]( x.data, 2 );
821+
* var v = fcns[ 0 ]( x, 2 );
822822
* // returns 3
823823
*/
824824
declare function arraylike2object( x: Uint16Array ): Uint16AccessorObject;
@@ -846,7 +846,7 @@ declare function arraylike2object( x: Uint16Array ): Uint16AccessorObject;
846846
* var fcns = obj.accessors;
847847
* // returns [ <Function>, <Function> ]
848848
*
849-
* var v = fcns[ 0 ]( x.data, 2 );
849+
* var v = fcns[ 0 ]( x, 2 );
850850
* // returns 3
851851
*/
852852
declare function arraylike2object( x: Uint8Array ): Uint8AccessorObject;
@@ -874,7 +874,7 @@ declare function arraylike2object( x: Uint8Array ): Uint8AccessorObject;
874874
* var fcns = obj.accessors;
875875
* // returns [ <Function>, <Function> ]
876876
*
877-
* var v = fcns[ 0 ]( x.data, 2 );
877+
* var v = fcns[ 0 ]( x, 2 );
878878
* // returns 3
879879
*/
880880
declare function arraylike2object( x: Uint8ClampedArray ): Uint8cAccessorObject;
@@ -903,7 +903,7 @@ declare function arraylike2object( x: Uint8ClampedArray ): Uint8cAccessorObject;
903903
* // returns [ <Function>, <Function> ]
904904
*
905905
* var v = fcns[ 0 ]( x, 1 );
906-
* // returns <Complex128>
906+
* // returns <Complex128>[ 3.0, 4.0 ]
907907
*/
908908
declare function arraylike2object( x: Complex128Array ): Complex128AccessorObject;
909909

@@ -931,7 +931,7 @@ declare function arraylike2object( x: Complex128Array ): Complex128AccessorObjec
931931
* // returns [ <Function>, <Function> ]
932932
*
933933
* var v = fcns[ 0 ]( x, 1 );
934-
* // returns <Complex64>
934+
* // returns <Complex64>[ 3.0, 4.0 ]
935935
*/
936936
declare function arraylike2object( x: Complex64Array ): Complex64AccessorObject;
937937

@@ -968,7 +968,7 @@ declare function arraylike2object( x: Complex64Array ): Complex64AccessorObject;
968968
* var fcns = obj.accessors;
969969
* // returns [ <Function>, <Function> ]
970970
*
971-
* var v = fcns[ 0 ]( x.data, 2 );
971+
* var v = fcns[ 0 ]( x, 2 );
972972
* // returns 3
973973
*/
974974
declare function arraylike2object<T = unknown>( x: AccessorArrayLike<T> ): GetSetAccessorObject<T>;
@@ -994,7 +994,7 @@ declare function arraylike2object<T = unknown>( x: AccessorArrayLike<T> ): GetSe
994994
* var fcns = obj.accessors;
995995
* // returns [ <Function>, <Function> ]
996996
*
997-
* var v = fcns[ 0 ]( x.data, 2 );
997+
* var v = fcns[ 0 ]( x, 2 );
998998
* // returns 3
999999
*/
10001000
declare function arraylike2object<T = unknown>( x: Array<T> ): GenericAccessorObject<T>;
@@ -1026,7 +1026,7 @@ declare function arraylike2object<T = unknown>( x: Array<T> ): GenericAccessorOb
10261026
* var fcns = obj.accessors;
10271027
* // returns [ <Function>, <Function> ]
10281028
*
1029-
* var v = fcns[ 0 ]( x.data, 2 );
1029+
* var v = fcns[ 0 ]( x, 2 );
10301030
* // returns 3
10311031
*/
10321032
declare function arraylike2object<T = unknown>( x: Collection<T> ): IndexedAccessorObject<T>;

0 commit comments

Comments
 (0)