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

Apply light editing to package docs #38

Merged
merged 1 commit into from
Jun 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions signalflow/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@

/*
Package signalflow contains a SignalFx SignalFlow client,
which can be used to execute analytics jobs against the SignalFx backend.
which is used to execute analytics jobs against the SignalFx backend.
Not all SignalFlow messages are handled at this time,
and some will be silently dropped.
All of the most important and useful ones are supported though.
You can expect some SignalFlow messages to be dropped, as the package does
not handle all SignalFlow messages at this time. However, all of the most
important and useful messages are supported.
The client will automatically attempt to reconnect to the backend
if the connection is broken after a short delay.
If the connection is broken, after a short delay the client automatically
attempts to reconnect to the backend.
SignalFlow is documented at https://dev.splunk.com/observability/docs/signalflow/messages.
*/
Expand Down
Loading