Skip to content

Update docs for Go client #10490

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

Merged
merged 2 commits into from
May 6, 2021
Merged

Conversation

wolfstudy
Copy link
Member

@wolfstudy wolfstudy commented May 6, 2021

Signed-off-by: xiaolongran [email protected]

Motivation

With the iteration of the Go client version, we have introduced many new interfaces and parameters, but the relevant documents have not been updated, resulting in inconsistencies between the documents and the code. This pr will focus on solving this problem and sort out all the parameters and interface lists related to client, producer, consumerand reader in the current Go client. Ensure that the documentation and code are consistent.

Modifications

  • Add Schema docs and code example for producer and consumer
  • update some docs

Verifying this change

  • Make sure that the change passes the CI checks.

Signed-off-by: xiaolongran <[email protected]>
@wolfstudy wolfstudy added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. doc-required Your PR changes impact docs and you will update later. labels May 6, 2021
@wolfstudy wolfstudy added this to the 2.8.0 milestone May 6, 2021
@wolfstudy wolfstudy self-assigned this May 6, 2021
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Many thanks for your contribution. I’ve left some comments, PTAL, thanks.

Signed-off-by: xiaolongran <[email protected]>
@wolfstudy
Copy link
Member Author

@Anonymitaet Thanks yu, PTAL again, thanks.

@merlimat merlimat merged commit 5a1264d into apache:master May 6, 2021
@merlimat merlimat removed the doc-required Your PR changes impact docs and you will update later. label May 6, 2021
eolivelli pushed a commit to eolivelli/pulsar that referenced this pull request May 11, 2021
* Update docs for Go client

Signed-off-by: xiaolongran <[email protected]>

* Fix comments

Signed-off-by: xiaolongran <[email protected]>

Co-authored-by: xiaolongran <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants