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

chore(docs): add docs for public types and functions #167

Merged
merged 1 commit into from
May 5, 2023

Conversation

haoqixu
Copy link
Member

@haoqixu haoqixu commented May 4, 2023

Update docs for public types and functions. Partially addresses #100.

@haoqixu haoqixu requested a review from a team May 4, 2023 02:40
Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

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

Thank you!

type OpAMPClient interface {

// Start the client and begin attempts to connect to the Server. Once connection
// is established the client will attempt to maintain it by reconnecting if
// the connection is lost. All failed connection attempts will be reported via
// OnConnectFailed callback.
//
// AgentDescription in settings MUST be set.
// SetAgentDescription() MUST be called before Start().
Copy link
Member

Choose a reason for hiding this comment

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

👍

@tigrannajaryan tigrannajaryan merged commit 29ef189 into open-telemetry:main May 5, 2023
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