Skip to content

Commit 3a1675c

Browse files
committed
doc: mention test runner retry attemp is zero based
1 parent fa2d6c7 commit 3a1675c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/api/test.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3875,7 +3875,9 @@ added: v25.0.0
38753875

38763876
* Type: {number}
38773877

3878-
Number of times the test has been attempted.
3878+
The attempt number of the test. This value is zero-based, so the first attempt is `0`,
3879+
the second attempt is `1`, and so on. This property is useful in conjunction with the
3880+
`--test-rerun-failures` option to determine which attempt the test is currently running.
38793881

38803882
### `context.workerId`
38813883

@@ -4248,9 +4250,9 @@ added: REPLACEME
42484250

42494251
* Type: {number}
42504252

4251-
The current attempt number of the suite. Used in conjunction with the
4252-
`--test-rerun-failures` option to determine the attempt number of the current
4253-
run.
4253+
The attempt number of the suite. This value is zero-based, so the first attempt is `0`,
4254+
the second attempt is `1`, and so on. This property is useful in conjunction with the
4255+
`--test-rerun-failures` option to determine the attempt number of the current run.
42544256

42554257
### `context.diagnostic(message)`
42564258

0 commit comments

Comments
 (0)