[DON-3517] Document subHeading naming difference for BPKSnippet and fix onClick example - #2794
Merged
Jasper Sion (jaspersion05) merged 1 commit intoAug 20, 2026
Conversation
…ple in Snippet README
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the Backpack Compose Snippet documentation to clarify cross-platform naming differences and adjust the Android Compose usage example.
Changes:
- Documented the intentional
subHeading(Android) vssubheading(iOS) parameter naming discrepancy. - Updated the Kotlin
BpkSnippetexample to useheadlineinstead ofdescription.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
80
to
82
| BpkSnippet( | ||
| description = description, | ||
| headline = headline, | ||
| subHeading = subHeading, |
Jasper Sion (jaspersion05)
added
the
minor
Jasper Sion (jaspersion05)
changed the title
Henrik Sym (henrik-sky)
added
skip-changelog
Henrik Sym (henrik-sky)
approved these changes
Aug 19, 2026
Jasper Sion (jaspersion05)
deleted the
donburi/DON-3517-Snippet-readme-naming-note
branch
August 20, 2026 09:10
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.
Summary
Docs-only fixes for the
SnippetCompose component README: corrects a broken usage example and documents a known iOS/Android naming discrepancy, rather than renaming the parameter (which would be a breaking API change).Changes
docs/compose/Snippet/README.md— it passeddescription = description, butBpkSnippethas nodescriptionparameter. Replaced withheadline = headline, matching the real signature.subHeadingon Android andsubheadingon iOS, and that this is an intentional, known discrepancy rather than a bug.Context
Found while working DON-3517 (Snippet iOS/Android parity audit). The naming mismatch itself was left un-renamed to avoid a breaking change for any caller using
subHeadingas a named argument.Test plan
BpkSnippet's real parameters (headline,subHeading,bodyText,imageOrientation,onClick) againstBpkSnippet.kt