docs(gno-js): Add provider instantiation docs #2427
Merged
+32
−0
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
gfanton
approved these changes
Jul 30, 2024
There was a problem hiding this comment.
Looks good! @zivkovicmilos, if you can give a quick look at this one
|
This PR is stale because it has been open 3 months with no activity. Remove stale label or comment or this will be closed in 3 months. |
leohhhn
approved these changes
Nov 15, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2427 +/- ##
==========================================
+ Coverage 54.68% 63.10% +8.42%
==========================================
Files 583 552 -31
Lines 78502 83853 +5351
==========================================
+ Hits 42927 52915 +9988
+ Misses 32367 27445 -4922
- Partials 3208 3493 +285
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
While using
gno-jsand reading the related docs, I saw the message saying that it's based ontm2-js-clientwith related link.This is useful to understand how it works and see the available methods from the base Provider classes, but doesn't inform the developer about how he should instantiate a provider with
gno-js-client, the name of the providers isn't mentioned anywhere and I had to guess it (or use my IDE autocomplete) and look at other projects using it to find out.This PR adds a small section to the documentation page with explicit instantiation examples to fix this (without repeating too much info, parameters for example are linked to
tm2-js-client, but could be extended in the future and documented here).Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description