docs: document limitation of WithUserAgent (#1747)

codyoss · web-flow · commit 567070f3835f · 2022-11-10T08:13:46.000-06:00
diff --git a/option/option.go b/option/option.go
@@ -96,7 +96,9 @@ func (w withScopes) Apply(o *internal.DialSettings) {
 	copy(o.Scopes, w)
 }
 
-// WithUserAgent returns a ClientOption that sets the User-Agent.
+// WithUserAgent returns a ClientOption that sets the User-Agent. This option
+// is incompatible with the [WithHTTPClient] option. If you wish to provide a
+// custom client you will need to add this header via RoundTripper middleware.
 func WithUserAgent(ua string) ClientOption {
 	return withUA(ua)
 }

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,9 @@ func (w withScopes) Apply(o *internal.DialSettings) {`
`96`	`96`	`copy(o.Scopes, w)`
`97`	`97`	`}`
`98`	`98`
`99`		`-// WithUserAgent returns a ClientOption that sets the User-Agent.`
	`99`	`+// WithUserAgent returns a ClientOption that sets the User-Agent. This option`
	`100`	`+// is incompatible with the [WithHTTPClient] option. If you wish to provide a`
	`101`	`+// custom client you will need to add this header via RoundTripper middleware.`
`100`	`102`	`func WithUserAgent(ua string) ClientOption {`
`101`	`103`	`return withUA(ua)`
`102`	`104`	`}`