From ec39a755143d4a397bf0ddbdb63e9415fb972b02 Mon Sep 17 00:00:00 2001 From: Paul Williams Date: Wed, 26 Jun 2024 13:55:25 -0700 Subject: [PATCH] Apply light editing to package docs --- signalflow/doc.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/signalflow/doc.go b/signalflow/doc.go index 69a3f0d..30d122e 100644 --- a/signalflow/doc.go +++ b/signalflow/doc.go @@ -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. */