Skip to content

chore(sdk): Refine comments for methods under IggyClient #1792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vax-r
Copy link
Contributor

@vax-r vax-r commented May 15, 2025

Summary

Currently some comments are missing or repeated for the methods under IggyClient.
Make the following changes to make the comments of IggyClient more complete.

  • Clarify comments for IggyClient::builder_from_connection_string()
  • Add comment for IggyClient::from_connection_string()

@vax-r vax-r changed the title sdk: Clarify comments for builder_from_connection_string sdk: Refine comments for methods under IggyClient May 15, 2025
@vax-r vax-r changed the title sdk: Refine comments for methods under IggyClient chore(sdk): Refine comments for methods under IggyClient May 15, 2025
@vax-r vax-r force-pushed the Refine_comment branch from aeac27e to b09d531 Compare May 15, 2025 16:56
@hubcio
Copy link
Contributor

hubcio commented Jun 19, 2025

@vax-r what's the status of this PR? do u have any plans to rebase it and merge it?

@vax-r
Copy link
Contributor Author

vax-r commented Jun 20, 2025

Hello @hubcio ,
Sure, it should've been fix in #1803 , but I missed it.

I'll rebase and refine it ASAP.

@hubcio
Copy link
Contributor

hubcio commented Jul 14, 2025

@vax-r ping 🦀

Ammend missing comments for "*from_connection_string()" in
the following type
* IggyClientBuilder
* IggyClient
* TcpClient

Signed-off-by: I Hsin Cheng <[email protected]>
@vax-r
Copy link
Contributor Author

vax-r commented Jul 16, 2025

@hubcio
Sorry for the late reply.
I've update it and rebase the commit.
Please take a look while you're available, thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants