Skip to content
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

feat: add description for Client interface #114

Closed
wants to merge 1 commit into from

Conversation

xuthus5
Copy link
Member

@xuthus5 xuthus5 commented Jul 17, 2024

Please do not merge requests until we have discussed the issue clearly.

Our open API should allow users to quickly understand how to use it, but at present, I still have misunderstandings about the definitions of ShowTagKeys and ShowSeries.I think the definitions of these APIs are very poor, ShowTagKeys, ShowTagValues, ShowFieldKeys, ShowSeries

  1. The purpose are unclear
  2. Input parameters command are unclear
  3. The return value type is unclear

@shoothzj
Copy link
Member

Can we add it to design doc first?

Copy link
Member

@shoothzj shoothzj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should establish a mechanism to synchronize method descriptions, as they contain language-independent content.

@xuthus5
Copy link
Member Author

xuthus5 commented Sep 6, 2024

impl by: #165 , close it.

@xuthus5 xuthus5 closed this Sep 6, 2024
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.

3 participants