chore(docs): document the health RPC method
#61
Merged
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
32 tasks
miraclx
requested changes
Apr 20, 2022
src/methods/health.rs
Outdated
| @@ -1,3 +1,27 @@ | |||
| //! Requests the health status of the rpc node. | |||
There was a problem hiding this comment.
Suggested change
| //! Requests the health status of the rpc node. | |
| //! Requests the health status of the RPC node. | |
| //! | |
| //! Returns an error if the node is syncing or has no new blocks. |
src/methods/health.rs
Outdated
| //! | ||
| //! assert!(matches!( | ||
| //! response, | ||
| //! methods::health::RpcHealthResponse { .. } |
There was a problem hiding this comment.
Suggested change
| //! methods::health::RpcHealthResponse { .. } | |
| //! methods::health::RpcHealthResponse |
miraclx
approved these changes
Apr 23, 2022
Merged
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.
Tracking issue: #51
Documented the
healthRPC method, including an easy-to-understand example.