fix: test.fixme condition parameter documentation #36977
+17
−17
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for
test.fixme()
condition and callback parameters incorrectly described the behavior as "should fail" when it should describe "fixme" behavior. This was a copy-paste error where thetest.fixme
documentation accidentally used descriptions fromtest.fail
.Before:
After:
The issue was present in both the markdown documentation (
docs/src/test-api/class-test.md
) and the generated TypeScript definitions (packages/playwright/types/test.d.ts
).Changes made:
test.fixme.condition
parameter description to correctly reference "fixme" behaviortest.fixme.callback
parameter description to correctly reference "fixme" behaviortest.skip
andtest.fail
documentation remains accurate and unchangedAll documentation linting and type checking tests pass with these changes.
Fixes #36976.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.