Skip to content

Commit

Permalink
docs: use single quotes in require calls instead of backticks
Browse files Browse the repository at this point in the history 
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.
  • Loading branch information
@Planeshifter
Planeshifter committed Jan 7, 2024
1 parent 0de3922 commit dea49e0
Show file tree
Hide file tree
Showing 1,087 changed files with 6,942 additions and 6,942 deletions.
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/array/base/accessor-getter/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ type GetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
* @returns accessor function
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var real = require( `@stdlib/array/real` );
* var imag = require( `@stdlib/array/imag` );
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/array/real' );
* var imag = require( '@stdlib/array/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
Expand All @@ -82,9 +82,9 @@ declare function getter( dtype: 'complex128' ): GetComplex128;
* @returns accessor function
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var realf = require( `@stdlib/array/realf` );
* var imagf = require( `@stdlib/array/imagf` );
* var Complex64Array = require( '@stdlib/array/complex64' );
* var realf = require( '@stdlib/array/realf' );
* var imagf = require( '@stdlib/array/imagf' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
Expand Down
16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/array/base/accessor-setter/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ type SetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => v
* @returns accessor function
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Complex128 = require( `@stdlib/complex/float64` );
* var real = require( `@stdlib/array/real` );
* var imag = require( `@stdlib/array/imag` );
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64' );
* var real = require( '@stdlib/array/real' );
* var imag = require( '@stdlib/array/imag' );
*
* var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
*
Expand All @@ -85,10 +85,10 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
* @returns accessor function
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Complex64 = require( `@stdlib/complex/float32` );
* var realf = require( `@stdlib/array/realf` );
* var imagf = require( `@stdlib/array/imagf` );
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32' );
* var realf = require( '@stdlib/array/realf' );
* var imagf = require( '@stdlib/array/imagf' );
*
* var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
*
Expand Down
22 changes: 11 additions & 11 deletions lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ interface GetSetAccessorObject<T> {
* @returns object containing accessor data
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -525,7 +525,7 @@ declare function accessors( x: Float64Array ): Float64AccessorObject;
* @returns object containing accessor data
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -553,7 +553,7 @@ declare function accessors( x: Float32Array ): Float32AccessorObject;
* @returns object containing accessor data
*
* @example
* var Int32Array = require( `@stdlib/array/int32` );
* var Int32Array = require( '@stdlib/array/int32' );
*
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -581,7 +581,7 @@ declare function accessors( x: Int32Array ): Int32AccessorObject;
* @returns object containing accessor data
*
* @example
* var Int16Array = require( `@stdlib/array/int16` );
* var Int16Array = require( '@stdlib/array/int16' );
*
* var x = new Int16Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -609,7 +609,7 @@ declare function accessors( x: Int16Array ): Int16AccessorObject;
* @returns object containing accessor data
*
* @example
* var Int8Array = require( `@stdlib/array/int8` );
* var Int8Array = require( '@stdlib/array/int8' );
*
* var x = new Int8Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -637,7 +637,7 @@ declare function accessors( x: Int8Array ): Int8AccessorObject;
* @returns object containing accessor data
*
* @example
* var Uint32Array = require( `@stdlib/array/uint32` );
* var Uint32Array = require( '@stdlib/array/uint32' );
*
* var x = new Uint32Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -665,7 +665,7 @@ declare function accessors( x: Uint32Array ): Uint32AccessorObject;
* @returns object containing accessor data
*
* @example
* var Uint16Array = require( `@stdlib/array/uint16` );
* var Uint16Array = require( '@stdlib/array/uint16' );
*
* var x = new Uint16Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -693,7 +693,7 @@ declare function accessors( x: Uint16Array ): Uint16AccessorObject;
* @returns object containing accessor data
*
* @example
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var x = new Uint8Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -721,7 +721,7 @@ declare function accessors( x: Uint8Array ): Uint8AccessorObject;
* @returns object containing accessor data
*
* @example
* var Uint8ClampedArray = require( `@stdlib/array/uint8c` );
* var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
*
* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -749,7 +749,7 @@ declare function accessors( x: Uint8ClampedArray ): Uint8cAccessorObject;
* @returns object containing accessor data
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down Expand Up @@ -777,7 +777,7 @@ declare function accessors( x: Complex128Array ): Complex128AccessorObject;
* @returns object containing accessor data
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1, 2, 3, 4 ] );
* var obj = accessors( x );
Expand Down
22 changes: 11 additions & 11 deletions lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ interface GetSetAccessorObject<T> {
* @returns object containing array data
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -595,7 +595,7 @@ declare function arraylike2object( x: Float64Array ): Float64AccessorObject;
* @returns object containing array data
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -623,7 +623,7 @@ declare function arraylike2object( x: Float32Array ): Float32AccessorObject;
* @returns object containing array data
*
* @example
* var Int32Array = require( `@stdlib/array/int32` );
* var Int32Array = require( '@stdlib/array/int32' );
*
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -651,7 +651,7 @@ declare function arraylike2object( x: Int32Array ): Int32AccessorObject;
* @returns object containing array data
*
* @example
* var Int16Array = require( `@stdlib/array/int16` );
* var Int16Array = require( '@stdlib/array/int16' );
*
* var x = new Int16Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -679,7 +679,7 @@ declare function arraylike2object( x: Int16Array ): Int16AccessorObject;
* @returns object containing array data
*
* @example
* var Int8Array = require( `@stdlib/array/int8` );
* var Int8Array = require( '@stdlib/array/int8' );
*
* var x = new Int8Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -707,7 +707,7 @@ declare function arraylike2object( x: Int8Array ): Int8AccessorObject;
* @returns object containing array data
*
* @example
* var Uint32Array = require( `@stdlib/array/uint32` );
* var Uint32Array = require( '@stdlib/array/uint32' );
*
* var x = new Uint32Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -735,7 +735,7 @@ declare function arraylike2object( x: Uint32Array ): Uint32AccessorObject;
* @returns object containing array data
*
* @example
* var Uint16Array = require( `@stdlib/array/uint16` );
* var Uint16Array = require( '@stdlib/array/uint16' );
*
* var x = new Uint16Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -763,7 +763,7 @@ declare function arraylike2object( x: Uint16Array ): Uint16AccessorObject;
* @returns object containing array data
*
* @example
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var x = new Uint8Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -791,7 +791,7 @@ declare function arraylike2object( x: Uint8Array ): Uint8AccessorObject;
* @returns object containing array data
*
* @example
* var Uint8ClampedArray = require( `@stdlib/array/uint8c` );
* var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
*
* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -819,7 +819,7 @@ declare function arraylike2object( x: Uint8ClampedArray ): Uint8cAccessorObject;
* @returns object containing array data
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down Expand Up @@ -847,7 +847,7 @@ declare function arraylike2object( x: Complex128Array ): Complex128AccessorObjec
* @returns object containing array data
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1, 2, 3, 4 ] );
* var obj = arraylike2object( x );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ interface Namespace {
* @returns boolean indicating whether a value is an accessor array
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var arr = new Complex128Array( 10 );
* var bool = ns.isAccessorArray( arr );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-accessor-array/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ interface AccessorArray {
* @returns boolean indicating whether a value is an accessor array
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var arr = new Complex128Array( 10 );
* var bool = isAccessorArray( arr );
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/array/base/binary2d/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
* @param fcn - binary callback
*
* @example
* var ones2d = require( `@stdlib/array/base/ones2d` );
* var zeros2d = require( `@stdlib/array/base/zeros2d` );
* var add = require( `@stdlib/math/base/ops/add` );
* var ones2d = require( '@stdlib/array/base/ones2d' );
* var zeros2d = require( '@stdlib/array/base/zeros2d' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var shape = [ 2, 2 ];
*
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/array/base/binary3d/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
* @param fcn - binary callback
*
* @example
* var ones3d = require( `@stdlib/array/base/ones3d` );
* var zeros3d = require( `@stdlib/array/base/zeros3d` );
* var add = require( `@stdlib/math/base/ops/add` );
* var ones3d = require( '@stdlib/array/base/ones3d' );
* var zeros3d = require( '@stdlib/array/base/zeros3d' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var shape = [ 2, 2, 2 ];
*
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/array/base/binary4d/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
* @param fcn - binary callback
*
* @example
* var ones4d = require( `@stdlib/array/base/ones4d` );
* var zeros4d = require( `@stdlib/array/base/zeros4d` );
* var add = require( `@stdlib/math/base/ops/add` );
* var ones4d = require( '@stdlib/array/base/ones4d' );
* var zeros4d = require( '@stdlib/array/base/zeros4d' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var shape = [ 1, 2, 2, 2 ];
*
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/array/base/binary5d/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ type Binary<T, U, V> = ( v1: T, v2: U ) => V;
* @param fcn - binary callback
*
* @example
* var ones5d = require( `@stdlib/array/base/ones5d` );
* var zeros5d = require( `@stdlib/array/base/zeros5d` );
* var add = require( `@stdlib/math/base/ops/add` );
* var ones5d = require( '@stdlib/array/base/ones5d' );
* var zeros5d = require( '@stdlib/array/base/zeros5d' );
* var add = require( '@stdlib/math/base/ops/add' );
*
* var shape = [ 1, 1, 2, 2, 2 ];
*
Expand Down
Loading

0 comments on commit dea49e0

Please sign in to comment.