Skip to content

Commit 796e21a

Browse files
committed
docs: replace tabs with spaces in JSDoc examples
--- 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 a5f969f commit 796e21a

1 file changed

Lines changed: 53 additions & 53 deletions

File tree

  • lib/node_modules/@stdlib/bench/harness/docs/types

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

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ interface Benchmark {
218218
*
219219
* @example
220220
* function benchmark( b ) {
221-
* b.comment( 'This is a comment.' );
221+
* b.comment( 'This is a comment.' );
222222
* }
223223
*/
224224
comment( msg: string ): void;
@@ -231,8 +231,8 @@ interface Benchmark {
231231
*
232232
* @example
233233
* function benchmark( b ) {
234-
* b.skip( false, 'This is skipped.' );
235-
* b.skip( true, 'This is skipped.' );
234+
* b.skip( false, 'This is skipped.' );
235+
* b.skip( true, 'This is skipped.' );
236236
* }
237237
*/
238238
skip( value: boolean, msg: string ): void;
@@ -249,8 +249,8 @@ interface Benchmark {
249249
*
250250
* @example
251251
* function benchmark( b ) {
252-
* b.todo( false, 'This is a todo.' );
253-
* b.todo( true, 'This is a todo.' );
252+
* b.todo( false, 'This is a todo.' );
253+
* b.todo( true, 'This is a todo.' );
254254
* }
255255
*/
256256
todo( value: boolean, msg: string ): void;
@@ -262,7 +262,7 @@ interface Benchmark {
262262
*
263263
* @example
264264
* function benchmark( b ) {
265-
* b.fail( 'This is a failing assertion.' );
265+
* b.fail( 'This is a failing assertion.' );
266266
* }
267267
*/
268268
fail( msg: string ): void;
@@ -274,7 +274,7 @@ interface Benchmark {
274274
*
275275
* @example
276276
* function benchmark( b ) {
277-
* b.fail( 'This is a passing assertion.' );
277+
* b.fail( 'This is a passing assertion.' );
278278
* }
279279
*/
280280
pass( msg: string ): void;
@@ -287,13 +287,13 @@ interface Benchmark {
287287
*
288288
* @example
289289
* function benchmark( b ) {
290-
* b.ok( [] );
290+
* b.ok( [] );
291291
* }
292292
*
293293
* @example
294294
* function benchmark( b ) {
295-
* b.ok( true, 'This asserts a value is truthy.' );
296-
* b.ok( false, 'This asserts a value is truthy.' );
295+
* b.ok( true, 'This asserts a value is truthy.' );
296+
* b.ok( false, 'This asserts a value is truthy.' );
297297
* }
298298
*/
299299
ok( value: boolean, msg?: string ): void;
@@ -306,13 +306,13 @@ interface Benchmark {
306306
*
307307
* @example
308308
* function benchmark( b ) {
309-
* b.notOk( null );
309+
* b.notOk( null );
310310
* }
311311
*
312312
* @example
313313
* function benchmark( b ) {
314-
* b.notOk( false, 'This asserts a value is falsy.' );
315-
* b.notOk( true, 'This asserts a value is falsy.' );
314+
* b.notOk( false, 'This asserts a value is falsy.' );
315+
* b.notOk( true, 'This asserts a value is falsy.' );
316316
* }
317317
*/
318318
notOk( value: boolean, msg?: string ): void;
@@ -329,16 +329,16 @@ interface Benchmark {
329329
* var actual = expected;
330330
*
331331
* function benchmark( b ) {
332-
* b.equal( actual, expected );
332+
* b.equal( actual, expected );
333333
* }
334334
*
335335
* @example
336336
* var expected = [];
337337
* var actual = expected;
338338
*
339339
* function benchmark( b ) {
340-
* b.equal( actual, expected, 'This asserts two values are strictly equal.' );
341-
* b.equal( 1.0, 2.0, 'This asserts two values are strictly equal.' );
340+
* b.equal( actual, expected, 'This asserts two values are strictly equal.' );
341+
* b.equal( 1.0, 2.0, 'This asserts two values are strictly equal.' );
342342
* }
343343
*/
344344
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -356,16 +356,16 @@ interface Benchmark {
356356
* var actual = [];
357357
*
358358
* function benchmark( b ) {
359-
* b.notEqual( actual, expected );
359+
* b.notEqual( actual, expected );
360360
* }
361361
*
362362
* @example
363363
* var expected = [];
364364
* var actual = [];
365365
*
366366
* function benchmark( b ) {
367-
* b.notEqual( 1.0, 2.0, 'This asserts two values are not equal.' );
368-
* b.notEqual( actual, expected, 'This asserts two values are not equal.' );
367+
* b.notEqual( 1.0, 2.0, 'This asserts two values are not equal.' );
368+
* b.notEqual( actual, expected, 'This asserts two values are not equal.' );
369369
* }
370370
*/
371371
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -380,29 +380,29 @@ interface Benchmark {
380380
*
381381
* @example
382382
* function benchmark( b ) {
383-
* var expected = {
384-
* 'a': 'b'
385-
* };
386-
* var actual = {
387-
* 'a': 'b'
388-
* };
389-
*
390-
* b.deepEqual( actual, expected );
383+
* var expected = {
384+
* 'a': 'b'
385+
* };
386+
* var actual = {
387+
* 'a': 'b'
388+
* };
389+
*
390+
* b.deepEqual( actual, expected );
391391
* }
392392
*
393393
* @example
394394
* function benchmark( b ) {
395-
* var expected = {
396-
* 'a': 'b'
397-
* };
398-
* var actual = {
399-
* 'a': 'b'
400-
* };
395+
* var expected = {
396+
* 'a': 'b'
397+
* };
398+
* var actual = {
399+
* 'a': 'b'
400+
* };
401401
*
402-
* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
402+
* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
403403
*
404-
* actual.a = 'c';
405-
* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
404+
* actual.a = 'c';
405+
* b.deepEqual( actual, expected, 'This asserts two values are deeply equal.' );
406406
* }
407407
*/
408408
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -417,29 +417,29 @@ interface Benchmark {
417417
*
418418
* @example
419419
* function benchmark( b ) {
420-
* var expected = {
421-
* 'a': 'b'
422-
* };
423-
* var actual = {
424-
* 'a': 'c'
425-
* };
426-
*
427-
* b.notDeepEqual( actual, expected );
420+
* var expected = {
421+
* 'a': 'b'
422+
* };
423+
* var actual = {
424+
* 'a': 'c'
425+
* };
426+
*
427+
* b.notDeepEqual( actual, expected );
428428
* }
429429
*
430430
* @example
431431
* function benchmark( b ) {
432-
* var expected = {
433-
* 'a': 'b'
434-
* };
435-
* var actual = {
436-
* 'a': 'c'
437-
* };
432+
* var expected = {
433+
* 'a': 'b'
434+
* };
435+
* var actual = {
436+
* 'a': 'c'
437+
* };
438438
*
439-
* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
439+
* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
440440
*
441-
* actual.a = 'b';
442-
* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
441+
* actual.a = 'b';
442+
* b.notDeepEqual( actual, expected, 'This asserts two values are not deeply equal.' );
443443
* }
444444
*/
445445
// eslint-disable-next-line @typescript-eslint/no-explicit-any

0 commit comments

Comments
 (0)