docs(offerings): clarify when PurchasesStoreProduct.description can be empty#1642
Open
SamAkinosun wants to merge 1 commit into
Open
docs(offerings): clarify when PurchasesStoreProduct.description can be empty#1642SamAkinosun wants to merge 1 commit into
SamAkinosun wants to merge 1 commit into
Conversation
tonidero
reviewed
May 11, 2026
tonidero
left a comment
Contributor
There was a problem hiding this comment.
Hi @SamAkinosun, thanks for the contribution! Agreed that the documentation for this property is lacking. I gave a suggestion to what you had to handle more the cases. Right now, description will indeed always be empty for RC Test Store, which is something we should improve. Thanks for the feedback! Once we address the feedback, I think we can get this merged
Comment on lines
+95
to
+99
| * - **Web (RevenueCat Test Store):** may be empty even for live products. | ||
| * | ||
| * Treat this as effectively optional even though the type is `string`: | ||
| * in some store configurations it can be empty even for live products. | ||
| * See https://github.com/RevenueCat/react-native-purchases/issues/1753. |
Contributor
There was a problem hiding this comment.
Maybe this:
Suggested change
| * - **Web (RevenueCat Test Store):** may be empty even for live products. | |
| * | |
| * Treat this as effectively optional even though the type is `string`: | |
| * in some store configurations it can be empty even for live products. | |
| * See https://github.com/RevenueCat/react-native-purchases/issues/1753. | |
| * - ** RevenueCat Test Store:** will be an empty string. | |
| * - ** Web (RC Billing): It will be the description of the product which may be empty. |
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.
Why
PurchasesStoreProduct.descriptionis documented as* Description of the product.with no further detail. Users who see an empty string have no way to know whether that's expected, an SDK bug, or misconfiguration on their end.This came up in RevenueCat/react-native-purchases#1753, where the reporter saw an empty string on web (RC Test Store) and on Android Play products without a description configured.
What this changes
Expands the JSDoc on
PurchasesStoreProduct.descriptionto:purchases-iosandpurchases-androidsource).string.Verification of platform claims
SK1StoreProduct.swiftexposeslocalizedDescriptionfromSKProduct.localizedDescription.SK2StoreProduct.swiftexposeslocalizedDescriptionfromProduct.description. Both reflect the App Store Connect description field.storeProductConversions.kt(ProductDetails.toStoreProduct(...)) populatesdescriptionfromProductDetails.description(JavagetDescription()). Returns\"\"when no description is set in Play Console.What this does NOT change
No code or behavior changes. Pure JSDoc improvement on a single field.