Skip to content

Commit dea49e0

Browse files
PlaneshifterPlaneshifter
committed
docs: use single quotes in require calls instead of backticks
Template strings via backticks were previously used by us because VSCode's Intellisense Markdown renderer didn't display example code inside TSDoc comments correctly otherwise. This is no longer the case.
1 parent 0de3922 commit dea49e0

File tree

1,087 files changed

+6942
-6942
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,087 files changed

+6942
-6942
lines changed

‎lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ type GetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
5757
* @returns accessor function
5858
*
5959
* @example
60-
* var Complex128Array = require( `@stdlib/array/complex128` );
61-
* var real = require( `@stdlib/array/real` );
62-
* var imag = require( `@stdlib/array/imag` );
60+
* var Complex128Array = require( '@stdlib/array/complex128' );
61+
* var real = require( '@stdlib/array/real' );
62+
* var imag = require( '@stdlib/array/imag' );
6363
*
6464
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
6565
*
@@ -82,9 +82,9 @@ declare function getter( dtype: 'complex128' ): GetComplex128;
8282
* @returns accessor function
8383
*
8484
* @example
85-
* var Complex64Array = require( `@stdlib/array/complex64` );
86-
* var realf = require( `@stdlib/array/realf` );
87-
* var imagf = require( `@stdlib/array/imagf` );
85+
* var Complex64Array = require( '@stdlib/array/complex64' );
86+
* var realf = require( '@stdlib/array/realf' );
87+
* var imagf = require( '@stdlib/array/imagf' );
8888
*
8989
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
9090
*

‎lib/node_modules/@stdlib/array/base/accessor-setter/docs/types/index.d.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ type SetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => v
5757
* @returns accessor function
5858
*
5959
* @example
60-
* var Complex128Array = require( `@stdlib/array/complex128` );
61-
* var Complex128 = require( `@stdlib/complex/float64` );
62-
* var real = require( `@stdlib/array/real` );
63-
* var imag = require( `@stdlib/array/imag` );
60+
* var Complex128Array = require( '@stdlib/array/complex128' );
61+
* var Complex128 = require( '@stdlib/complex/float64' );
62+
* var real = require( '@stdlib/array/real' );
63+
* var imag = require( '@stdlib/array/imag' );
6464
*
6565
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
6666
*
@@ -85,10 +85,10 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
8585
* @returns accessor function
8686
*
8787
* @example
88-
* var Complex64Array = require( `@stdlib/array/complex64` );
89-
* var Complex64 = require( `@stdlib/complex/float32` );
90-
* var realf = require( `@stdlib/array/realf` );
91-
* var imagf = require( `@stdlib/array/imagf` );
88+
* var Complex64Array = require( '@stdlib/array/complex64' );
89+
* var Complex64 = require( '@stdlib/complex/float32' );
90+
* var realf = require( '@stdlib/array/realf' );
91+
* var imagf = require( '@stdlib/array/imagf' );
9292
*
9393
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
9494
*

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ interface GetSetAccessorObject<T> {
497497
* @returns object containing accessor data
498498
*
499499
* @example
500-
* var Float64Array = require( `@stdlib/array/float64` );
500+
* var Float64Array = require( '@stdlib/array/float64' );
501501
*
502502
* var x = new Float64Array( [ 1, 2, 3, 4 ] );
503503
* var obj = accessors( x );
@@ -525,7 +525,7 @@ declare function accessors( x: Float64Array ): Float64AccessorObject;
525525
* @returns object containing accessor data
526526
*
527527
* @example
528-
* var Float32Array = require( `@stdlib/array/float32` );
528+
* var Float32Array = require( '@stdlib/array/float32' );
529529
*
530530
* var x = new Float32Array( [ 1, 2, 3, 4 ] );
531531
* var obj = accessors( x );
@@ -553,7 +553,7 @@ declare function accessors( x: Float32Array ): Float32AccessorObject;
553553
* @returns object containing accessor data
554554
*
555555
* @example
556-
* var Int32Array = require( `@stdlib/array/int32` );
556+
* var Int32Array = require( '@stdlib/array/int32' );
557557
*
558558
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
559559
* var obj = accessors( x );
@@ -581,7 +581,7 @@ declare function accessors( x: Int32Array ): Int32AccessorObject;
581581
* @returns object containing accessor data
582582
*
583583
* @example
584-
* var Int16Array = require( `@stdlib/array/int16` );
584+
* var Int16Array = require( '@stdlib/array/int16' );
585585
*
586586
* var x = new Int16Array( [ 1, 2, 3, 4 ] );
587587
* var obj = accessors( x );
@@ -609,7 +609,7 @@ declare function accessors( x: Int16Array ): Int16AccessorObject;
609609
* @returns object containing accessor data
610610
*
611611
* @example
612-
* var Int8Array = require( `@stdlib/array/int8` );
612+
* var Int8Array = require( '@stdlib/array/int8' );
613613
*
614614
* var x = new Int8Array( [ 1, 2, 3, 4 ] );
615615
* var obj = accessors( x );
@@ -637,7 +637,7 @@ declare function accessors( x: Int8Array ): Int8AccessorObject;
637637
* @returns object containing accessor data
638638
*
639639
* @example
640-
* var Uint32Array = require( `@stdlib/array/uint32` );
640+
* var Uint32Array = require( '@stdlib/array/uint32' );
641641
*
642642
* var x = new Uint32Array( [ 1, 2, 3, 4 ] );
643643
* var obj = accessors( x );
@@ -665,7 +665,7 @@ declare function accessors( x: Uint32Array ): Uint32AccessorObject;
665665
* @returns object containing accessor data
666666
*
667667
* @example
668-
* var Uint16Array = require( `@stdlib/array/uint16` );
668+
* var Uint16Array = require( '@stdlib/array/uint16' );
669669
*
670670
* var x = new Uint16Array( [ 1, 2, 3, 4 ] );
671671
* var obj = accessors( x );
@@ -693,7 +693,7 @@ declare function accessors( x: Uint16Array ): Uint16AccessorObject;
693693
* @returns object containing accessor data
694694
*
695695
* @example
696-
* var Uint8Array = require( `@stdlib/array/uint8` );
696+
* var Uint8Array = require( '@stdlib/array/uint8' );
697697
*
698698
* var x = new Uint8Array( [ 1, 2, 3, 4 ] );
699699
* var obj = accessors( x );
@@ -721,7 +721,7 @@ declare function accessors( x: Uint8Array ): Uint8AccessorObject;
721721
* @returns object containing accessor data
722722
*
723723
* @example
724-
* var Uint8ClampedArray = require( `@stdlib/array/uint8c` );
724+
* var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
725725
*
726726
* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );
727727
* var obj = accessors( x );
@@ -749,7 +749,7 @@ declare function accessors( x: Uint8ClampedArray ): Uint8cAccessorObject;
749749
* @returns object containing accessor data
750750
*
751751
* @example
752-
* var Complex128Array = require( `@stdlib/array/complex128` );
752+
* var Complex128Array = require( '@stdlib/array/complex128' );
753753
*
754754
* var x = new Complex128Array( [ 1, 2, 3, 4 ] );
755755
* var obj = accessors( x );
@@ -777,7 +777,7 @@ declare function accessors( x: Complex128Array ): Complex128AccessorObject;
777777
* @returns object containing accessor data
778778
*
779779
* @example
780-
* var Complex64Array = require( `@stdlib/array/complex64` );
780+
* var Complex64Array = require( '@stdlib/array/complex64' );
781781
*
782782
* var x = new Complex64Array( [ 1, 2, 3, 4 ] );
783783
* var obj = accessors( x );

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ interface GetSetAccessorObject<T> {
567567
* @returns object containing array data
568568
*
569569
* @example
570-
* var Float64Array = require( `@stdlib/array/float64` );
570+
* var Float64Array = require( '@stdlib/array/float64' );
571571
*
572572
* var x = new Float64Array( [ 1, 2, 3, 4 ] );
573573
* var obj = arraylike2object( x );
@@ -595,7 +595,7 @@ declare function arraylike2object( x: Float64Array ): Float64AccessorObject;
595595
* @returns object containing array data
596596
*
597597
* @example
598-
* var Float32Array = require( `@stdlib/array/float32` );
598+
* var Float32Array = require( '@stdlib/array/float32' );
599599
*
600600
* var x = new Float32Array( [ 1, 2, 3, 4 ] );
601601
* var obj = arraylike2object( x );
@@ -623,7 +623,7 @@ declare function arraylike2object( x: Float32Array ): Float32AccessorObject;
623623
* @returns object containing array data
624624
*
625625
* @example
626-
* var Int32Array = require( `@stdlib/array/int32` );
626+
* var Int32Array = require( '@stdlib/array/int32' );
627627
*
628628
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
629629
* var obj = arraylike2object( x );
@@ -651,7 +651,7 @@ declare function arraylike2object( x: Int32Array ): Int32AccessorObject;
651651
* @returns object containing array data
652652
*
653653
* @example
654-
* var Int16Array = require( `@stdlib/array/int16` );
654+
* var Int16Array = require( '@stdlib/array/int16' );
655655
*
656656
* var x = new Int16Array( [ 1, 2, 3, 4 ] );
657657
* var obj = arraylike2object( x );
@@ -679,7 +679,7 @@ declare function arraylike2object( x: Int16Array ): Int16AccessorObject;
679679
* @returns object containing array data
680680
*
681681
* @example
682-
* var Int8Array = require( `@stdlib/array/int8` );
682+
* var Int8Array = require( '@stdlib/array/int8' );
683683
*
684684
* var x = new Int8Array( [ 1, 2, 3, 4 ] );
685685
* var obj = arraylike2object( x );
@@ -707,7 +707,7 @@ declare function arraylike2object( x: Int8Array ): Int8AccessorObject;
707707
* @returns object containing array data
708708
*
709709
* @example
710-
* var Uint32Array = require( `@stdlib/array/uint32` );
710+
* var Uint32Array = require( '@stdlib/array/uint32' );
711711
*
712712
* var x = new Uint32Array( [ 1, 2, 3, 4 ] );
713713
* var obj = arraylike2object( x );
@@ -735,7 +735,7 @@ declare function arraylike2object( x: Uint32Array ): Uint32AccessorObject;
735735
* @returns object containing array data
736736
*
737737
* @example
738-
* var Uint16Array = require( `@stdlib/array/uint16` );
738+
* var Uint16Array = require( '@stdlib/array/uint16' );
739739
*
740740
* var x = new Uint16Array( [ 1, 2, 3, 4 ] );
741741
* var obj = arraylike2object( x );
@@ -763,7 +763,7 @@ declare function arraylike2object( x: Uint16Array ): Uint16AccessorObject;
763763
* @returns object containing array data
764764
*
765765
* @example
766-
* var Uint8Array = require( `@stdlib/array/uint8` );
766+
* var Uint8Array = require( '@stdlib/array/uint8' );
767767
*
768768
* var x = new Uint8Array( [ 1, 2, 3, 4 ] );
769769
* var obj = arraylike2object( x );
@@ -791,7 +791,7 @@ declare function arraylike2object( x: Uint8Array ): Uint8AccessorObject;
791791
* @returns object containing array data
792792
*
793793
* @example
794-
* var Uint8ClampedArray = require( `@stdlib/array/uint8c` );
794+
* var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
795795
*
796796
* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );
797797
* var obj = arraylike2object( x );
@@ -819,7 +819,7 @@ declare function arraylike2object( x: Uint8ClampedArray ): Uint8cAccessorObject;
819819
* @returns object containing array data
820820
*
821821
* @example
822-
* var Complex128Array = require( `@stdlib/array/complex128` );
822+
* var Complex128Array = require( '@stdlib/array/complex128' );
823823
*
824824
* var x = new Complex128Array( [ 1, 2, 3, 4 ] );
825825
* var obj = arraylike2object( x );
@@ -847,7 +847,7 @@ declare function arraylike2object( x: Complex128Array ): Complex128AccessorObjec
847847
* @returns object containing array data
848848
*
849849
* @example
850-
* var Complex64Array = require( `@stdlib/array/complex64` );
850+
* var Complex64Array = require( '@stdlib/array/complex64' );
851851
*
852852
* var x = new Complex64Array( [ 1, 2, 3, 4 ] );
853853
* var obj = arraylike2object( x );

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ interface Namespace {
5858
* @returns boolean indicating whether a value is an accessor array
5959
*
6060
* @example
61-
* var Complex128Array = require( `@stdlib/array/complex128` );
61+
* var Complex128Array = require( '@stdlib/array/complex128' );
6262
*
6363
* var arr = new Complex128Array( 10 );
6464
* var bool = ns.isAccessorArray( arr );

‎lib/node_modules/@stdlib/array/base/assert/is-accessor-array/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ interface AccessorArray {
5555
* @returns boolean indicating whether a value is an accessor array
5656
*
5757
* @example
58-
* var Complex128Array = require( `@stdlib/array/complex128` );
58+
* var Complex128Array = require( '@stdlib/array/complex128' );
5959
*
6060
* var arr = new Complex128Array( 10 );
6161
* var bool = isAccessorArray( arr );

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
4444
* @param fcn - binary callback
4545
*
4646
* @example
47-
* var ones2d = require( `@stdlib/array/base/ones2d` );
48-
* var zeros2d = require( `@stdlib/array/base/zeros2d` );
49-
* var add = require( `@stdlib/math/base/ops/add` );
47+
* var ones2d = require( '@stdlib/array/base/ones2d' );
48+
* var zeros2d = require( '@stdlib/array/base/zeros2d' );
49+
* var add = require( '@stdlib/math/base/ops/add' );
5050
*
5151
* var shape = [ 2, 2 ];
5252
*

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
4444
* @param fcn - binary callback
4545
*
4646
* @example
47-
* var ones3d = require( `@stdlib/array/base/ones3d` );
48-
* var zeros3d = require( `@stdlib/array/base/zeros3d` );
49-
* var add = require( `@stdlib/math/base/ops/add` );
47+
* var ones3d = require( '@stdlib/array/base/ones3d' );
48+
* var zeros3d = require( '@stdlib/array/base/zeros3d' );
49+
* var add = require( '@stdlib/math/base/ops/add' );
5050
*
5151
* var shape = [ 2, 2, 2 ];
5252
*

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
4444
* @param fcn - binary callback
4545
*
4646
* @example
47-
* var ones4d = require( `@stdlib/array/base/ones4d` );
48-
* var zeros4d = require( `@stdlib/array/base/zeros4d` );
49-
* var add = require( `@stdlib/math/base/ops/add` );
47+
* var ones4d = require( '@stdlib/array/base/ones4d' );
48+
* var zeros4d = require( '@stdlib/array/base/zeros4d' );
49+
* var add = require( '@stdlib/math/base/ops/add' );
5050
*
5151
* var shape = [ 1, 2, 2, 2 ];
5252
*

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
4444
* @param fcn - binary callback
4545
*
4646
* @example
47-
* var ones5d = require( `@stdlib/array/base/ones5d` );
48-
* var zeros5d = require( `@stdlib/array/base/zeros5d` );
49-
* var add = require( `@stdlib/math/base/ops/add` );
47+
* var ones5d = require( '@stdlib/array/base/ones5d' );
48+
* var zeros5d = require( '@stdlib/array/base/zeros5d' );
49+
* var add = require( '@stdlib/math/base/ops/add' );
5050
*
5151
* var shape = [ 1, 1, 2, 2, 2 ];
5252
*

0 commit comments

Comments
 (0)