Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix: test.fixme condition parameter documentation (#36977)

Copilot999d0cdf7b52
diff --git a/docs/src/test-api/class-test.md b/docs/src/test-api/class-test.md
index ab0efba7fb..977c9d83e5 100644
--- a/docs/src/test-api/class-test.md
+++ b/docs/src/test-api/class-test.md
@@ -1289,13 +1289,13 @@ Test body that takes one or two arguments: an object with fixtures and optional
* since: v1.10
- `condition` ?<[boolean]>
-Test is marked as "should fail" when the condition is `true`.
+Test is marked as "fixme" when the condition is `true`.
### param: Test.fixme.callback
* since: v1.10
- `callback` ?<[function]\([Fixtures]\):[boolean]>
-A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as "should fail" when the return value is `true`.
+A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme" when the return value is `true`.
### param: Test.fixme.description
* since: v1.10
diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts
index 32c285071e..ae1a6ba88b 100644
--- a/packages/playwright/types/test.d.ts
+++ b/packages/playwright/types/test.d.ts
@@ -4606,9 +4606,9 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
* description.
* @param body Test body that takes one or two arguments: an object with fixtures and optional
* [TestInfo](https://playwright.dev/docs/api/class-testinfo).
- * @param condition Test is marked as "should fail" when the condition is `true`.
- * @param callback A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as
- * "should fail" when the return value is `true`.
+ * @param condition Test is marked as "fixme" when the condition is `true`.
+ * @param callback A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme"
+ * when the return value is `true`.
* @param description Optional description that will be reflected in a test report.
*/
fixme(title: string, body: TestBody<TestArgs & WorkerArgs>): void;
@@ -4684,9 +4684,9 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
* description.
* @param body Test body that takes one or two arguments: an object with fixtures and optional
* [TestInfo](https://playwright.dev/docs/api/class-testinfo).
- * @param condition Test is marked as "should fail" when the condition is `true`.
- * @param callback A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as
- * "should fail" when the return value is `true`.
+ * @param condition Test is marked as "fixme" when the condition is `true`.
+ * @param callback A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme"
+ * when the return value is `true`.
* @param description Optional description that will be reflected in a test report.
*/
fixme(title: string, details: TestDetails, body: TestBody<TestArgs & WorkerArgs>): void;
@@ -4762,9 +4762,9 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
* description.
* @param body Test body that takes one or two arguments: an object with fixtures and optional
* [TestInfo](https://playwright.dev/docs/api/class-testinfo).
- * @param condition Test is marked as "should fail" when the condition is `true`.
- * @param callback A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as
- * "should fail" when the return value is `true`.
+ * @param condition Test is marked as "fixme" when the condition is `true`.
+ * @param callback A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme"
+ * when the return value is `true`.
* @param description Optional description that will be reflected in a test report.
*/
fixme(): void;
@@ -4840,9 +4840,9 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
* description.
* @param body Test body that takes one or two arguments: an object with fixtures and optional
* [TestInfo](https://playwright.dev/docs/api/class-testinfo).
- * @param condition Test is marked as "should fail" when the condition is `true`.
- * @param callback A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as
- * "should fail" when the return value is `true`.
+ * @param condition Test is marked as "fixme" when the condition is `true`.
+ * @param callback A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme"
+ * when the return value is `true`.
* @param description Optional description that will be reflected in a test report.
*/
fixme(condition: boolean, description?: string): void;
@@ -4918,9 +4918,9 @@ export interface TestType<TestArgs extends {}, WorkerArgs extends {}> {
* description.
* @param body Test body that takes one or two arguments: an object with fixtures and optional
* [TestInfo](https://playwright.dev/docs/api/class-testinfo).
- * @param condition Test is marked as "should fail" when the condition is `true`.
- * @param callback A function that returns whether to mark as "should fail", based on test fixtures. Test or tests are marked as
- * "should fail" when the return value is `true`.
+ * @param condition Test is marked as "fixme" when the condition is `true`.
+ * @param callback A function that returns whether to mark as "fixme", based on test fixtures. Test or tests are marked as "fixme"
+ * when the return value is `true`.
* @param description Optional description that will be reflected in a test report.
*/
fixme(callback: ConditionBody<TestArgs & WorkerArgs>, description?: string): void;