Clarify API usage #1811
Merged
Clarify API usage #1811
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
site/docs-md/apis/index.md
Outdated
| 1) Import the API: | ||
| ```typescript | ||
| import { Browser } from '@capacitor/core'; |
There was a problem hiding this comment.
Suggested change
| import { Browser } from '@capacitor/core'; | |
| import { Plugins } from '@capacitor/core'; |
There was a problem hiding this comment.
Added a comment, but after reading the changes, I don't think they make the usage it clearer, the wording seems even more confusing.
Instead of "Import the API" could be "Import the Plugins object, it represents the Registry of all Capacitor plugins" or something like that.
Instead of "Extract the API object from Plugins:" could be, "Get the Plugin from the Plugin Registry (Plugins) object".
Instead of " Use the API:", " Use the Plugin API:"
I don't understand the "By instead leveraging the API object".
Co-Authored-By: jcesarmobile <jcesarmobile@gmail.com>
Co-Authored-By: jcesarmobile <jcesarmobile@gmail.com>
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.
Multiple users (myself including) have been confused by how to leverage Capacitor APIs properly. it's really easy to forget to use the API object itself - here's an attempt to clarify things.