Skip to content

Commit dedae83

Browse files
committed
docs: replace example given this context is not bound for clbk but fcn
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - 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: passed - task: lint_license_headers status: passed ---
1 parent 7d92c02 commit dedae83

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

lib/node_modules/@stdlib/utils/map-arguments/docs/types/index.d.ts

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,30 @@ declare function mapArguments<
7070
* @returns function wrapper
7171
*
7272
* @example
73-
* function foo( a, b, c ) {
74-
* return [ a, b, c ];
75-
* }
76-
*
7773
* function clbk( v ) {
78-
* this.count += 1;
7974
* return v * 2;
8075
* }
8176
*
82-
* var thisArg = { 'count': 0 };
83-
* var bar = mapArguments( foo, clbk, thisArg );
77+
* function Foo() {
78+
* this.x = 1;
79+
* this.y = 2;
80+
* }
81+
*
82+
* Foo.prototype.scale = function scale( a, b ) {
83+
* return [ this.x*a, this.y*b ];
84+
* };
8485
*
85-
* var out = bar( 1, 2, 3 );
86-
* // returns [ 2, 4, 6 ]
86+
* var ctx = {
87+
* 'x': 10,
88+
* 'y': 20
89+
* };
90+
*
91+
* var foo = new Foo();
92+
*
93+
* var bar = mapArguments( foo.scale, clbk, ctx );
8794
*
88-
* var count = thisArg.count;
89-
* // returns 3
95+
* var out = bar( 1, 2 );
96+
* // returns [ 20, 80 ]
9097
*/
9198
declare function mapArguments<
9299
T extends ( ...args: Array<any> ) => any,

lib/node_modules/@stdlib/utils/map-arguments/docs/types/test.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
* limitations under the License.
1717
*/
1818

19+
/* eslint-disable jsdoc/require-jsdoc */
20+
1921
import mapArguments = require( './index' );
2022

2123
// FUNCTIONS //

0 commit comments

Comments
 (0)