Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typos, highlighted important parts, moved important information to the top (iOS/Android only, Deprecated etc) #357

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nikita0x
Copy link

Thank you for contributing to RevenueCat/purchases-capacitor. Before pressing the "Create Pull Request" button, please provide the following:

  • A description about what and why you are contributing, even if it's trivial.
  • Why?
    Because I like RevenueCat and how easy it makes everything to work with subs and all that jazz... Really a lot of work off our shoulders.
  • What are you contributing?
    I am contributing some improvements (in my opinion) and some typos to documentation.

Before
image
After
image

On the first line I wanted to have important information - if it is Deprecated, iOS or Android only, so that people (and me) sometimes read through the docs of what a method does, when implementing for a specific platform to only discover at the very end, that that platform is not supported. I think it should be on the first line, in the beginning.
Also, I tried to separate it from the main wall of text to visually distinct it from what a method does.
So like you hover over a method - it says "iOS only" and I understand - "Oh, okay. I don't need to read the rest and waste my time since I am working on Android".

Secondly, I added highlight for variables or objects whatever the method returns, what is important. Again to visually distinct it from the docs.

Before
image

After
image

Please, point out anything that needs correction, or decline it altogether if you think it is not worth to be added.

  • The issue number(s) or PR number(s) in the description if you are contributing in response to those.
    None, idk.

  • If applicable, unit tests.
    There is no need for unit tests, I guess? For documentation.

… to the top (iOS/Android only, Deprecated etc)
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