This repository was archived by the owner on Jan 22, 2025. It is now read-only.
Add more API documentation for Rust RpcClient #19021
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
Another thing this patch does is add an "RPC Reference" section to some of the methods that links to the RPC spec for the underlying protocol. The intent is to avoid having to reproduce the protocol documentation in the API. |
brson
force-pushed
the
docs-rpc-client-checkpoint-2
branch
from
55b98df to
319c19e
Compare
Codecov Report
@@ Coverage Diff @@
## master #19021 +/- ##
=========================================
- Coverage 82.7% 82.7% -0.1%
=========================================
Files 449 449
Lines 127997 128035 +38
=========================================
- Hits 105968 105961 -7
- Misses 22029 22074 +45 |
Contributor
CriesofCarrots
left a comment
CriesofCarrots
left a comment
There was a problem hiding this comment.
Thank you! Just a couple suggestions and nits. (Sorry that there's no good way to preserve 80-char wrapping in github suggestions!)
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
Co-authored-by: Tyera Eulberg <[email protected]>
brson
force-pushed
the
docs-rpc-client-checkpoint-2
branch
from
ca70369 to
0f039ec
Compare
Contributor
Author
|
Updated with all suggestions resolved. Thanks for the good review @CriesofCarrots |
CriesofCarrots
approved these changes
Aug 5, 2021
Contributor
CriesofCarrots
left a comment
CriesofCarrots
left a comment
There was a problem hiding this comment.
Thanks! lgtm
I'll hand-hold it through CI
mergify bot
pushed a commit
that referenced
this pull request
Aug 5, 2021
* Add doc links to Transaction API docs * Add more RpcClient API docs * Reflow some rpc_client docs * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/src/transaction.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update RpcClient docs per review Co-authored-by: Tyera Eulberg <[email protected]> (cherry picked from commit b67ffab)
mergify bot
added a commit
that referenced
this pull request
Aug 5, 2021
* Add doc links to Transaction API docs * Add more RpcClient API docs * Reflow some rpc_client docs * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update client/src/rpc_client.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update sdk/src/transaction.rs Co-authored-by: Tyera Eulberg <[email protected]> * Update RpcClient docs per review Co-authored-by: Tyera Eulberg <[email protected]> (cherry picked from commit b67ffab) Co-authored-by: Brian Anderson <[email protected]>
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
This adds more API docs and examples for the Rust RpcClient.
Followup to #18748
The biggest changes here are relatively complete docs for
get_signature_statuses,get_signature_statuses_with_history,confirm_transaction, andconfirm_transaction_with_commitment. I have also added preliminary examples for more methods as I familiarize myself with the code. Some of these examples need improvement still, and I intend to revisit them when I write their full docs.It's been about two weeks of work since my last patch, and this patch is pretty sizable, so I am looking for feedback. After this PR I plan to continue documenting this module. I also have a patch of integration tests for RpcClient that I intend to submit eventually.