Skip to content

Commit 489b13e

Browse files
committed
Fix TypeScript documentation for t.try()
1 parent 4bf64d0 commit 489b13e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -346,29 +346,29 @@ export interface TimeoutFn {
346346

347347
export interface TryFn<Context = unknown> {
348348
/**
349-
* Requires opt-in. Attempt to run some assertions. The result must be explicitly committed or discarded or else
349+
* Attempt to run some assertions. The result must be explicitly committed or discarded or else
350350
* the test will fail. A macro may be provided. The title may help distinguish attempts from
351351
* one another.
352352
*/
353353
<Args extends any[]>(title: string, fn: EitherMacro<Args, Context>, ...args: Args): Promise<TryResult>;
354354

355355
/**
356-
* Requires opt-in. Attempt to run some assertions. The result must be explicitly committed or discarded or else
356+
* Attempt to run some assertions. The result must be explicitly committed or discarded or else
357357
* the test will fail. A macro may be provided. The title may help distinguish attempts from
358358
* one another.
359359
*/
360360
<Args extends any[]>(title: string, fn: [EitherMacro<Args, Context>, ...Array<EitherMacro<Args, Context>>], ...args: Args): Promise<TryResult[]>;
361361

362362
/**
363-
* Requires opt-in. Attempt to run some assertions. The result must be explicitly committed or discarded or else
364-
* the test will fail. A macro may be provided.
365-
*/
363+
* Attempt to run some assertions. The result must be explicitly committed or discarded or else
364+
* the test will fail. A macro may be provided.
365+
*/
366366
<Args extends any[]>(fn: EitherMacro<Args, Context>, ...args: Args): Promise<TryResult>;
367367

368368
/**
369-
* Requires opt-in. Attempt to run some assertions. The result must be explicitly committed or discarded or else
370-
* the test will fail. A macro may be provided.
371-
*/
369+
* Attempt to run some assertions. The result must be explicitly committed or discarded or else
370+
* the test will fail. A macro may be provided.
371+
*/
372372
<Args extends any[]>(fn: [EitherMacro<Args, Context>, ...Array<EitherMacro<Args, Context>>], ...args: Args): Promise<TryResult[]>;
373373
}
374374

0 commit comments

Comments
 (0)