Skip to content

Commit a729aff

Browse files
kgrytekgryte
committed
chore: clean-up and update documentation
--- 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: passed - 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 1187431 commit a729aff

File tree

7 files changed

+11
-2
lines changed

7 files changed

+11
-2
lines changed

‎lib/node_modules/@stdlib/object/assign/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ var bool = ( z === x );
7373

7474
- If a property key is present in multiple sources, the property from the last source that defines the key prevails.
7575
- The target object is mutated.
76+
- Both string and symbol properties are copied.
7677

7778
</section>
7879

‎lib/node_modules/@stdlib/object/assign/docs/repl.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
If a property key is present in multiple sources, the property from the last
77
source that defines the key prevails.
88

9+
Both string and symbol properties are copied.
10+
911
The target object is mutated.
1012

1113
Parameters

‎lib/node_modules/@stdlib/object/assign/docs/types/index.d.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
*
2626
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
2727
* - The target object is mutated.
28+
* - Both string and symbol properties are copied.
2829
*
2930
* @param target - target object
3031
* @param source - source object
@@ -51,6 +52,7 @@ declare function assign<T extends object, U>( target: T, source: U ): T & U;
5152
*
5253
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
5354
* - The target object is mutated.
55+
* - Both string and symbol properties are copied.
5456
*
5557
* @param target - target object
5658
* @param source1 - first source object
@@ -67,6 +69,7 @@ declare function assign<T extends object, U, V>( target: T, source1: U, source2:
6769
*
6870
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
6971
* - The target object is mutated.
72+
* - Both string and symbol properties are copied.
7073
*
7174
* @param target - target object
7275
* @param source1 - first source object
@@ -84,6 +87,7 @@ declare function assign<T extends object, U, V, W>( target: T, source1: U, sourc
8487
*
8588
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
8689
* - The target object is mutated.
90+
* - Both string and symbol properties are copied.
8791
*
8892
* @param target - target object
8993
* @param source - source object(s)

‎lib/node_modules/@stdlib/object/assign/lib/builtin.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
*
2828
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
2929
* - The target object is mutated.
30+
* - Both string and symbol properties are copied.
3031
*
3132
* @name assign
3233
* @type {Function}

‎lib/node_modules/@stdlib/object/assign/lib/polyfill.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ var format = require( '@stdlib/string/format' );
3434
*
3535
* - If a property key is present in multiple sources, the property from the last source that defines the key prevails.
3636
* - The target object is mutated.
37+
* - Both string and symbol properties are copied.
3738
*
3839
* @param {Object} target - target object
3940
* @param {...Object} source - source object(s)

‎lib/node_modules/@stdlib/object/assign/test/test.builtin.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ tape( 'the function throws an error if provided `undefined` or `null` as a targe
4949
var i;
5050

5151
values = [
52-
undefined,
52+
void 0,
5353
null
5454
];
5555

‎lib/node_modules/@stdlib/object/assign/test/test.polyfill.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ tape( 'the function throws an error if provided `undefined` or `null` as a targe
4646
var i;
4747

4848
values = [
49-
undefined,
49+
void 0,
5050
null
5151
];
5252

0 commit comments

Comments
 (0)