docs: document limitation of WithUserAgent (#1747)

googleapis · Nov 10, 2022 · 567070f · 567070f
1 parent 561b601
commit 567070f
Showing 1 changed file with 3 additions and 1 deletion.
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)
 }