From 0e8e1172e6b596e8f87e7152029a34ec17daa63e Mon Sep 17 00:00:00 2001 From: Casey Waldren Date: Wed, 13 Mar 2024 10:58:00 -0700 Subject: [PATCH] attempt to shorten doc line length to appease linter --- interfaces/service_endpoints.go | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/interfaces/service_endpoints.go b/interfaces/service_endpoints.go index dbcb6e87..728abef3 100644 --- a/interfaces/service_endpoints.go +++ b/interfaces/service_endpoints.go @@ -2,17 +2,20 @@ package interfaces // ServiceEndpoints allow configuration of custom service URIs. // -// If you want to set non-default values for any of these fields, set the ServiceEndpoints field -// in the SDK's [github.com/launchdarkly/go-server-sdk/v7.Config] struct. You may set individual -// values such as Streaming, or use the helper method +// If you want to set non-default values for any of these fields, +// set the ServiceEndpoints field in the SDK's +// [github.com/launchdarkly/go-server-sdk/v7.Config] struct. +// You may set individual values such as Streaming, or use the helper method // [github.com/launchdarkly/go-server-sdk/v7/ldcomponents.RelayProxyEndpoints]. // -// Important note: if one or more URI is set to a custom value, then all URIs should be set to custom values. -// Otherwise, the SDK will emit an error-level log to surface this potential misconfiguration, while using default values for -// the unset URIs. +// Important note: if one or more URI is set to a custom value, then +// all URIs should be set to custom values. Otherwise, the SDK will emit +// an error-level log to surface this potential misconfiguration, while +// using default values for the unset URIs. // -// There are some scenarios where it is desirable to set only some of the fields, but this is not recommended for general -// usage. If you're scenario requires it, you can call [WithPartialSpecification] to suppress the +// There are some scenarios where it is desirable to set only some of the +// fields, but this is not recommended for general usage. If you're scenario +// requires it, you can call [WithPartialSpecification] to suppress the // error message. // // See Config.ServiceEndpoints for more details. @@ -23,15 +26,17 @@ type ServiceEndpoints struct { allowPartialSpecification bool } -// WithPartialSpecification returns a copy of this ServiceEndpoints that will not trigger an error-level log message -// if only some, but not all the fields are set to custom values. This is an advanced configuration and likely not necessary -// for most use-cases. +// WithPartialSpecification returns a copy of this ServiceEndpoints that will +// not trigger an error-level log message if only some, but not all the fields +// are set to custom values. This is an advanced configuration and likely not +// necessary for most use-cases. func (s ServiceEndpoints) WithPartialSpecification() ServiceEndpoints { s.allowPartialSpecification = true return s } -// PartialSpecificationRequested returns true if this ServiceEndpoints should not be treated as malformed if some, but not all fields are set. +// PartialSpecificationRequested returns true if this ServiceEndpoints should not +// be treated as malformed if some, but not all fields are set. func (s ServiceEndpoints) PartialSpecificationRequested() bool { return s.allowPartialSpecification }