fix(bench): update TS doc examples to reference benchmark argument

Author: DivitJain26

lib/node_modules/@stdlib/bench/harness/docs/types/index.d.ts

@@ -111,7 +111,7 @@ interface Benchmark {
 	*
 	* @example
 	* var str = b.name;
-	* // returns <string>
+	* // throws <ReferenceError>
 	*/
 	readonly name: string;
 
@@ -120,7 +120,7 @@ interface Benchmark {
 	*
 	* @example
 	* var iter = b.iterations;
-	* // returns <number>
+	* // throws <ReferenceError>
 	*/
 	readonly iterations: number;
 
@@ -217,7 +217,9 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.comment( 'This is a comment.' );
+	* function benchmark( b ) {
+	* 	b.comment( 'This is a comment.' );
+	* }
 	*/
 	comment( msg: string ): void;
 
@@ -228,8 +230,10 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.skip( false, 'This is skipped.' );
-	* b.skip( true, 'This is skipped.' );
+	* function benchmark( b ) {
+	* 	b.skip( false, 'This is skipped.' );
+	* 	b.skip( true, 'This is skipped.' );
+	* }
 	*/
 	skip( value: any, msg: string ): void;
 
@@ -244,8 +248,10 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.todo( false, 'This is a todo.' );
-	* b.todo( true, 'This is a todo.' );
+	* function benchmark( b ) {
+	* 	b.todo( false, 'This is a todo.' );
+	* 	b.todo( true, 'This is a todo.' );
+	* }
 	*/
 	todo( value: any, msg: string ): void;
 
@@ -255,7 +261,9 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.fail( 'This is a failing assertion.' );
+	* function benchmark( b ) {
+	* 	b.fail( 'This is a failing assertion.' );
+	* }
 	*/
 	fail( msg: string ): void;
 
@@ -265,7 +273,9 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.fail( 'This is a passing assertion.' );
+	* function benchmark( b ) {
+	* 	b.fail( 'This is a passing assertion.' );
+	* }
 	*/
 	pass( msg: string ): void;
 
@@ -276,11 +286,15 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.ok( [] );
+	* function benchmark( b ) {
+	* 	b.ok( [] );
+	* }
 	*
 	* @example
-	* b.ok( true, 'This asserts a value is truthy.' );
-	* b.ok( false, 'This asserts a value is truthy.' );
+	* function benchmark( b ) {
+	* 	b.ok( true, 'This asserts a value is truthy.' );
+	* 	b.ok( false, 'This asserts a value is truthy.' );
+	* }
 	*/
 	ok( value: any, msg?: string ): void;
 
@@ -291,11 +305,15 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* b.notOk( null );
+	* function benchmark( b ) {
+	* 	b.notOk( null );
+	* }
 	*
 	* @example
-	* b.notOk( false, 'This asserts a value is falsy.' );
-	* b.notOk( true, 'This asserts a value is falsy.' );
+	* function benchmark( b ) {
+	* 	b.notOk( false, 'This asserts a value is falsy.' );
+	* 	b.notOk( true, 'This asserts a value is falsy.' );
+	* }
 	*/
 	notOk( value: any, msg?: string ): void;
 
@@ -310,14 +328,18 @@ interface Benchmark {
 	* var expected = [];
 	* var actual = expected;
 	*
-	* b.equal( actual, expected );
+	* function benchmark( b ) {
+	* 	b.equal( actual, expected );
+	* }
 	*
 	* @example
 	* var expected = [];
 	* var actual = expected;
 	*
-	* b.equal( actual, expected, 'This asserts two values are strictly equal.' );
-	* b.equal( 1.0, 2.0, 'This asserts two values are strictly equal.' );
+	* function benchmark( b ) {
+	* 	b.equal( actual, expected, 'This asserts two values are strictly equal.' );
+	* 	b.equal( 1.0, 2.0, 'This asserts two values are strictly equal.' );
+	* }
 	*/
 	equal( actual: any, expected: any, msg?: string ): void;
 
@@ -332,14 +354,18 @@ interface Benchmark {
 	* var expected = [];
 	* var actual = [];
 	*
-	* b.notEqual( actual, expected );
+	* function benchmark( b ) {
+	* 	b.notEqual( actual, expected );
+	* }
 	*
 	* @example
 	* var expected = [];
 	* var actual = [];
 	*
-	* b.notEqual( 1.0, 2.0, 'This asserts two values are not equal.' );
-	* b.notEqual( actual, expected, 'This asserts two values are not equal.' );
+	* function benchmark( b ) {
+	* 	b.notEqual( 1.0, 2.0, 'This asserts two values are not equal.' );
+	* 	b.notEqual( actual, expected, 'This asserts two values are not equal.' );
+	* }
 	*/
 	notEqual( actual: any, expected: any, msg?: string ): void;
 
@@ -351,27 +377,31 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* var expected = {
-	*     'a': 'b'
-	* };
-	* var actual = {
-	*     'a': 'b'
-	* };
-	*
-	* b.deepEqual( actual, expected );
+	* function benchmark( b ) {
+	* 	var expected = {
+	* 	    'a': 'b'
+	* 	};
+	* 	var actual = {
+	* 	    'a': 'b'
+	* 	};
+	*
+	* 	b.deepEqual( actual, expected );
+	* }
 	*
 	* @example
-	* var expected = {
-	*     'a': 'b'
-	* };
-	* var actual = {
-	*     'a': 'b'
-	* };
+	* function benchmark( b ) {
+	* 	var expected = {
+	* 	    'a': 'b'
+	* 	};
+	* 	var actual = {
+	* 	    'a': 'b'
+	* 	};
 	*
-	* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
+	* 	b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
 	*
-	* actual.a = 'c';
-	* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
+	* 	actual.a = 'c';
+	* 	b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
+	* }
 	*/
 	deepEqual( actual: any, expected: any, msg?: string ): void;
 
@@ -383,27 +413,31 @@ interface Benchmark {
 	* @param msg - message
 	*
 	* @example
-	* var expected = {
-	*     'a': 'b'
-	* };
-	* var actual = {
-	*     'a': 'c'
-	* };
-	*
-	* b.notDeepEqual( actual, expected );
+	* function benchmark( b ) {
+	* 	var expected = {
+	* 	    'a': 'b'
+	* 	};
+	* 	var actual = {
+	* 	    'a': 'c'
+	* 	};
+	*
+	* 	b.notDeepEqual( actual, expected );
+	* }
 	*
 	* @example
-	* var expected = {
-	*     'a': 'b'
-	* };
-	* var actual = {
-	*     'a': 'c'
-	* };
+	* function benchmark( b ) {
+	* 	var expected = {
+	* 	    'a': 'b'
+	* 	};
+	* 	var actual = {
+	* 	    'a': 'c'
+	* 	};
 	*
-	* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
+	* 	b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
 	*
-	* actual.a = 'b';
-	* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
+	* 	actual.a = 'b';
+	* 	b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
+	* }
 	*/
 	notDeepEqual( actual: any, expected: any, msg?: string ): void;
 }