search

GameAnalytics / GA-SDK-ROBLOX

Repository for GameAnalytics Roblox SDK
MIT License
68 stars 45 forks source link

Clarify usage of ProcessReceiptCallback in documentation. #100

Closed Bentechy66 closed 2 years ago

Bentechy66 commented 2 years ago

The GameAnalytics:ProcessReceiptCallback is only mentioned very briefly in the documentation. It is unclear that this function actually adds the business event for you. The text Also you should call GameAnalytics:ProcessReceiptCallback(Info) within your own game:GetService("MarketplaceService").ProcessReceipt method. is shown just above an example of manually submitting a business event to the library. This is somewhat misleading and could cause a developer to send duplicate events to the server, one from the ProcessReceiptCallback method, and one from their own manual creation of the business event.

I'd suggest making it clear that this function actually creates the business event for you.

the1schwartz commented 2 years ago

Thanks for mentioning this. I have updated the docs to explain it better now.