Skip to content

Commit 449e0e3

Browse files
committed
docs: rename alias
1 parent 04230cb commit 449e0e3

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

lib/node_modules/@stdlib/array/convert/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# Convert
21+
# convert
2222

2323
> Convert an array to an array of a different data type.
2424
@@ -37,16 +37,16 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var convertArray = require( '@stdlib/array/convert' );
40+
var convert = require( '@stdlib/array/convert' );
4141
```
4242

43-
#### convertArray( arr, dtype )
43+
#### convert( arr, dtype )
4444

4545
Converts an array to an array of a different data type.
4646

4747
```javascript
4848
var arr = [ 1.0, 2.0, 3.0 ];
49-
var out = convertArray( arr, 'float32' );
49+
var out = convert( arr, 'float32' );
5050
// returns <Float32Array>[ 1.0, 2.0, 3.0 ]
5151
```
5252

@@ -89,7 +89,7 @@ The function supports the following data types:
8989
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
9090
var filledarrayBy = require( '@stdlib/array/filled-by' );
9191
var dtypes = require( '@stdlib/array/dtypes' );
92-
var convertArray = require( '@stdlib/array/convert' );
92+
var convert = require( '@stdlib/array/convert' );
9393

9494
// Create a generic array:
9595
var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) );
@@ -101,7 +101,7 @@ var DTYPES = dtypes();
101101
var out;
102102
var i;
103103
for ( i = 0; i < DTYPES.length; i++ ) {
104-
out = convertArray( arr, DTYPES[ i ] );
104+
out = convert( arr, DTYPES[ i ] );
105105
console.log( out );
106106
}
107107
```

lib/node_modules/@stdlib/array/convert/examples/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
2222
var filledarrayBy = require( '@stdlib/array/filled-by' );
2323
var dtypes = require( '@stdlib/array/dtypes' );
24-
var convertArray = require( './../lib' );
24+
var convert = require( './../lib' );
2525

2626
// Create a generic array:
2727
var arr = filledarrayBy( 5, 'generic', discreteUniform( -100, 100 ) );
@@ -33,6 +33,6 @@ var DTYPES = dtypes();
3333
var out;
3434
var i;
3535
for ( i = 0; i < DTYPES.length; i++ ) {
36-
out = convertArray( arr, DTYPES[ i ] );
36+
out = convert( arr, DTYPES[ i ] );
3737
console.log( out );
3838
}

0 commit comments

Comments
 (0)