[GEN-1903] Add docs to https://github.com/qawolf/docs for new APIs#136
Draft
Joonil Kim (bartholomaeuskim) wants to merge 3 commits into
Draft
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
expect is the real implementation post-unification (GEN-1885/1884/1907) and can be referenced at module level; only its matcher calls need the running flow. Mirrors the troubleshooting.mdx update. Addresses Jon's ask to refresh references with old examples.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Overview of Problem
Per GEN-1903 — the
expectreferences in the flows API docs still describe the pre-GEN-1885 "type-safe stub" world. After the GEN-1885/GEN-1884/GEN-1907 chain lands,expectis the real assertion library on every entry point, and the troubleshooting page contains a stub-error section that can no longer fire.Overview of Changes
Five edits across four files refresh the references to match the post-unification surface:
android.mdx/ios.mdx:expectsection now points atexpect-webdriveriomatchers and cross-links to the native screenshot guide fortoHaveScreenshot.cli.mdx:expectsection now points at theexpectpackage (Jest matchers) with a more realistictoMatchObjectexample.web.mdx: newexpectsection pointing at Playwright'sexpectwith auto-retrying locator matchers and a cross-link to the web screenshot guide.troubleshooting.mdx: deletes the`expect` Throws A Stub Errorsection (stub can no longer fire after GEN-1885); dropsexpectfrom the "Runtime API Called Outside The Flow Callback" cause list (expectis now safe at module level).Blocked by qawolf/platform#26255 (GEN-1907) — the mobile
toHaveScreenshotcross-links assume the unified mobile matcher is available. Mark ready once that lands.