From 67c430435a1c340d2c4bd334c0f31446d8666a32 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Tue, 23 Apr 2024 14:07:37 -0700 Subject: [PATCH] docs: more accurate test id description (#30487) Reference https://github.com/microsoft/playwright/issues/30430 --- docs/src/test-reporter-api/class-testcase.md | 2 +- packages/playwright/types/testReporter.d.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/test-reporter-api/class-testcase.md b/docs/src/test-reporter-api/class-testcase.md index 1b1dfb7845..a601b284cd 100644 --- a/docs/src/test-reporter-api/class-testcase.md +++ b/docs/src/test-reporter-api/class-testcase.md @@ -34,7 +34,7 @@ See also [`property: TestResult.status`] for the actual status. * since: v1.25 - type: <[string]> -Unique test ID that is computed based on the test file name, test title and project name. Test ID can be used as a history ID. +A test ID that is computed based on the test file name, test title and project name. The ID is unique within Playwright session. ## property: TestCase.location * since: v1.10 diff --git a/packages/playwright/types/testReporter.d.ts b/packages/playwright/types/testReporter.d.ts index 250deef694..2b61ffaeea 100644 --- a/packages/playwright/types/testReporter.d.ts +++ b/packages/playwright/types/testReporter.d.ts @@ -710,8 +710,8 @@ export interface TestCase { expectedStatus: "passed"|"failed"|"timedOut"|"skipped"|"interrupted"; /** - * Unique test ID that is computed based on the test file name, test title and project name. Test ID can be used as a - * history ID. + * A test ID that is computed based on the test file name, test title and project name. The ID is unique within + * Playwright session. */ id: string;