docs: correct capture examples and RAW conversion semantics - #690
Open
OskarEichler wants to merge 2 commits into
Open
docs: correct capture examples and RAW conversion semantics#690OskarEichler wants to merge 2 commits into
OskarEichler wants to merge 2 commits into
Conversation
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
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.
Fixes
Make the high-level snippets valid JavaScript, document omission of captureMode rather than a nonexistent none value, explain WebP/raw results accurately, distinguish binary RAW files from base64 results, separate native capture from Node conversion, preserve the already-PNG fallback, and avoid duplicate file URI prefixes when sharing. Correct CI/test coverage claims: Android Detox is disabled, iOS Detox is non-blocking, several native assertions are best-effort, and the snapshot helper does not compare decoded pixels. Document the actual web artifact names and preserve Linux references.
Compatibility / observable changes
Documentation only. No benchmark guarantee is made. Node conversion uses built-in fs/zlib and the optional pngjs package; these are not React Native built-ins.
Verification
All README JavaScript snippets parse. The Node converter round-trips RAW pixels, preserves an already-encoded PNG, and rejects inconsistent RAW headers.
This patch was applied independently to upstream commit
6acbec50a5e3cab7d668711d757c52cfdc791c76and passed its targeted external actual-source diagnostics. Across the focused patches, 119 such checks pass. Java/Objective-C diagnostics use controlled bridge/platform doubles or owned filesystem fixtures; they are not substitutes for physical-device rendering tests.Combined branch checks:
The separate iOS cleanup patch intentionally makes the existing test named
testReleaseCapture_currentlyDeletesPrefixOnlyImposterDirectories_KNOWN_LOOSE_GUARDfail because it asserts the unsafe old behavior. That patch is kept in a separate draft PR. No checked-in test/spec or snapshot files were added, modified, regenerated or disabled.Windows/Expo native builds, physical-device video/PixelCopy output, and full Detox suites were not run. The full unchanged Playwright suite was run against both baseline and patched builds: both have 9 passes and the same 3 failures. Two Linux-reference screenshot mismatches have byte-identical baseline/patched actual images on macOS. The CORS fixture hard-codes port 3000, occupied by an unrelated local backend; the isolated example uses another port. No snapshots or assertions were changed. React Doctor also reports existing example suggestions and a React-18 ref-cleanup warning; the latter was checked against actual React 18 legacy-ref and React 19 cleanup behavior. No rules were suppressed.
Scope
README.mdsrc/index.tsxexample/e2e/README.mdexample-web/README.mdUnrelated audit changes are submitted separately.