Improve docs part 2 #131
Merged
Improve docs part 2 #131
Conversation
This file contains 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
aboedo
commented
Jul 27, 2022
Comment on lines
-11
to
-15
| public delegate void LogInFunc(CustomerInfo customerInfo, bool created, Error error); | ||
|
|
||
| public delegate void GetOfferingsFunc(Offerings offerings, Error error); | ||
|
|
||
| public delegate void CheckTrialOrIntroductoryPriceEligibilityFunc(Dictionary<string, IntroEligibility> products); |
There was a problem hiding this comment.
I moved these closer to where they're actually used, so it's much easier to understand what they actually do
Comment on lines
+692
to
+699
| /// <summary> | ||
| /// Subscriber attributes are useful for storing additional, structured information on a user. | ||
| /// Since attributes are writable using a public key they should not be used for | ||
| /// managing secure or sensitive information such as subscription status, coins, etc. | ||
| /// </summary> | ||
| /// | ||
| /// <remarks>Key names starting with "$" are reserved names used by RevenueCat. For a full list of key | ||
| /// restrictions refer [to our guide](https://docs.revenuecat.com/docs/subscriber-attributes) |
There was a problem hiding this comment.
most of these docstrings are adapted from iOS
Closed
aboedo
force-pushed
the
improve_docs_part_2
branch
from
47f1129
to
5c6756d
Compare
aboedo
force-pushed
the
improve_docs_part_2
branch
from
5c6756d
to
e2b38a9
Compare
|
@RevenueCat/core-sdk bump |
Merged
taquitos
approved these changes
Jul 29, 2022
RevenueCat/Scripts/Purchases.cs
Outdated
| /// </remarks> | ||
| /// | ||
| /// <param name="products"> The <see cref="StoreProduct"/> for which you want to compute eligibility.</param> | ||
| /// <param name="callback"> The <see cref="CheckTrialOrIntroductoryPriceEligibilityCallback"/> callback. </param> |
There was a problem hiding this comment.
CheckTrialOrIntroductoryPriceEligibilityCallback -> CheckTrialOrIntroductoryPriceEligibilityFunc
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.
Part 2 of adding docstrings to public methods in the Purchases class.
Public members of other public classes don't have docstrings yet, but I might add them later on after having released this.