Skip to content

docs(android): Consolidate snapshot annotation options into one table#18640

Open
runningcode wants to merge 1 commit into
masterfrom
no/android-snapshots-annotation-table
Open

docs(android): Consolidate snapshot annotation options into one table#18640
runningcode wants to merge 1 commit into
masterfrom
no/android-snapshots-annotation-table

Conversation

@runningcode

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Consolidates the Android snapshot annotation docs into a single reference table. Previously the @Preview attributes, the @SentrySnapshot annotation, and diffThreshold were documented across separate subsections (group, name, and a tag-mapping table), so there was no single place to see every option that shapes a snapshot.

  • Replaces the group/name/Tags subsections with one "Preview Annotation Reference" table covering all 13 @Preview attributes plus @SentrySnapshot's diffThreshold
  • Each row documents the rendering effect and how the attribute is recorded in the snapshot's JSON metadata (tag vs. field)
  • Documents two behaviors verified against the plugin's generated Paparazzi test: wallpaper is ignored during rendering, and backgroundColor affects rendering but isn't recorded in metadata

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

🤖 Generated with Claude Code

The @Preview attributes, the @SentrySnapshot annotation, and the
diffThreshold were documented across separate subsections, so there was
no single place to see every option that shapes a snapshot. Replace the
group/name/tags subsections with one reference table covering all
@Preview attributes plus @SentrySnapshot's diffThreshold, including how
each is recorded in the snapshot metadata.

Also document two behaviors verified against the generated Paparazzi
test: wallpaper is ignored during rendering, and backgroundColor
affects rendering but isn't recorded in metadata.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jul 6, 2026 7:27am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jul 6, 2026 7:27am

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team July 6, 2026 07:17
Look at this example preview:
For example, this preview:

```kotlin

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The description for diffThreshold is ambiguous, suggesting an inclusive threshold (>=) while the actual behavior is exclusive (>), creating an inconsistency with other documentation.
Severity: LOW

Suggested Fix

Update the description for diffThreshold to explicitly state that the share of changed pixels must be "greater than" or "exceed" the value to be reported as changed. This will align it with the actual behavior and other documentation.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: docs/platforms/android/snapshots/index.mdx#L252

Potential issue: The new documentation for `diffThreshold` describes it as the "Minimum
share of changed pixels...required to report," which implies an inclusive comparison
(>=). This contradicts the actual behavior and existing documentation across multiple
files, which state that a snapshot is reported as changed only when the share of changed
pixels "exceeds" or is "greater than" the threshold (>). This ambiguity could cause
users to misconfigure the threshold, expecting a change to be reported at the exact
threshold value when it will not be.

Did we get this right? 👍 / 👎 to inform future reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant