chore(sdk): Refine comments for methods under IggyClient
#1792
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
vax-r
changed the title
IggyClient
vax-r
changed the title
IggyClientIggyClient
Current comment for IggyClient::builder_from_connection_string() overlaps with IggyClient::builder(). To clarify the difference between two methods, refine the comments for IggyClient::builder_from_connection_string(). Signed-off-by: I Hsin Cheng <richard120310@gmail.com>
Currenly there's no comment for IggyClient::from_connection_string(), add the corresponding comments for it and states only TCP transport is supported for current implementation. Signed-off-by: I Hsin Cheng <richard120310@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.
Summary
Currently some comments are missing or repeated for the methods under
IggyClient.Make the following changes to make the comments of
IggyClientmore complete.IggyClient::builder_from_connection_string()IggyClient::from_connection_string()