Skip to content

Commit ae6c33f

Browse files
committed
chore: add suggestions
--- 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: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - 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: na - task: lint_license_headers status: passed ---
1 parent 128a273 commit ae6c33f

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

lib/node_modules/@stdlib/array/base/to-inserted-at/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# toInsertedAt
2222

23-
> Return a new array with the element at the specified index inserted with a provided value.
23+
> Return a new array containing every element from an input array, with a provided value inserted at a specified index.
2424

2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -42,7 +42,7 @@ var toInsertedAt = require( '@stdlib/array/base/to-inserted-at' );
4242

4343
#### toInsertedAt( x, index, value )
4444

45-
Returns a new array with the element at the specified index inserted with a provided value.
45+
Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
4646

4747
```javascript
4848
var x = [ 1, 2, 3, 4 ];

lib/node_modules/@stdlib/array/base/to-inserted-at/docs/repl.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( x, index, value )
3-
Returns a new array with the element at the specified index inserted with a
4-
provided value.
3+
Returns a new array containing every element from an input array, with a
4+
provided value inserted at a specified index.
55

66
Negative indices are resolved relative to the last array element, with the
77
last element corresponding to `-1`.
@@ -34,8 +34,8 @@
3434

3535

3636
{{alias}}.assign( x, index, value, out, stride, offset )
37-
Copies elements from one array to another array and inserts the element at
38-
the specified index to a provided value.
37+
Copies elements from one array to another array and with a provided value
38+
inserted at a specified index.
3939

4040
Negative indices are resolved relative to the last array element, with the
4141
last element corresponding to `-1`.

lib/node_modules/@stdlib/array/base/to-inserted-at/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { ComplexLike } from '@stdlib/types/complex';
2828
*/
2929
interface Array2InsertedAt {
3030
/**
31-
* Returns a new array with the element at the specified index inserted with a provided value.
31+
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
3232
*
3333
* @param x - input array
3434
* @param index - index at which to set a provided value
@@ -47,7 +47,7 @@ interface Array2InsertedAt {
4747
<T extends ComplexTypedArray>( x: T, index: number, value: ComplexLike ): T;
4848

4949
/**
50-
* Returns a new array with the element at the specified index inserted with a provided value.
50+
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
5151
*
5252
* @param x - input array
5353
* @param index - index at which to set a provided value
@@ -65,7 +65,7 @@ interface Array2InsertedAt {
6565
<T extends RealTypedArray>( x: T, index: number, value: number ): T; // eslint-disable-line @typescript-eslint/unified-signatures
6666

6767
/**
68-
* Returns a new array with the element at the specified index inserted with a provided value.
68+
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
6969
*
7070
* @param x - input array
7171
* @param index - index at which to set a provided value
@@ -212,7 +212,7 @@ interface Array2InsertedAt {
212212
}
213213

214214
/**
215-
* Returns a new array with the element at the specified index inserted with a provided value.
215+
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
216216
*
217217
* @param x - input array
218218
* @param index - index at which to set a provided value

lib/node_modules/@stdlib/array/base/to-inserted-at/lib/assign.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ var format = require( '@stdlib/string/format' );
3636
// FUNCTIONS //
3737

3838
/**
39-
* Copies elements from one array to another array and inserts the element at the specified index to a provided value.
39+
* Copies elements from one array to another array and with a provided value inserted at a specified index.
4040
*
4141
* @private
4242
* @param {Collection} x - input array
@@ -75,7 +75,7 @@ function indexed( x, index, value, out, stride, offset ) {
7575
}
7676

7777
/**
78-
* Copies elements from one accessor array to another accessor array and inserts the element at the specified index to a provided value.
78+
* Copies elements from one accessor array to another accessor array and with a provided value inserted at a specified index.
7979
*
8080
* @private
8181
* @param {Object} x - input array object
@@ -128,7 +128,7 @@ function accessors( x, index, value, out, stride, offset ) {
128128
}
129129

130130
/**
131-
* Copies elements from one complex array to another complex array and inserts the element at the specified index to a provided value.
131+
* Copies elements from one complex array to another complex array and with a provided value inserted at a specified index.
132132
*
133133
* @private
134134
* @param {Collection} x - real-valued floating-point input array view
@@ -175,7 +175,7 @@ function complex( x, index, value, out, stride, offset ) {
175175
// MAIN //
176176

177177
/**
178-
* Copies elements from one array to another array and inserts the element at the specified index to a provided value.
178+
* Copies elements from one array to another array and with a provided value inserted at a specified index.
179179
*
180180
* @param {Collection} x - input array
181181
* @param {integer} index - element index

lib/node_modules/@stdlib/array/base/to-inserted-at/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Return a new array with the element at the specified index inserted with a provided value.
22+
* Return a new array containing every element from an input array, with a provided value inserted at a specified index.
2323
*
2424
* @module @stdlib/array/base/to-inserted-at
2525
*

lib/node_modules/@stdlib/array/base/to-inserted-at/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var assign = require( './assign.js' );
3030
// MAIN //
3131

3232
/**
33-
* Returns a new array with the element at the specified index inserted with a provided value.
33+
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
3434
*
3535
* @param {Collection} x - input array
3636
* @param {integer} index - element index

0 commit comments

Comments
 (0)