docs(option): clarify behavior of WithScopes (#1670)

eisandbar · web-flow · commit 07ceb9d607c8 · 2022-08-17T21:04:11.000Z
Clarify that when both WithScopes and WithTokenSource are used, the scope settings will be taken from the token source and the WithScopes option will be ignored. Fixes #1644
diff --git a/option/option.go b/option/option.go
@@ -82,6 +82,9 @@ func (w withEndpoint) Apply(o *internal.DialSettings) {
 
 // WithScopes returns a ClientOption that overrides the default OAuth2 scopes
 // to be used for a service.
+//
+// If both WithScopes and WithTokenSource are used, scope settings from the
+// token source will be used instead.
 func WithScopes(scope ...string) ClientOption {
 	return withScopes(scope)
 }

Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,9 @@ func (w withEndpoint) Apply(o *internal.DialSettings) {`
`82`	`82`
`83`	`83`	`// WithScopes returns a ClientOption that overrides the default OAuth2 scopes`
`84`	`84`	`// to be used for a service.`
	`85`	`+//`
	`86`	`+// If both WithScopes and WithTokenSource are used, scope settings from the`
	`87`	`+// token source will be used instead.`
`85`	`88`	`func WithScopes(scope ...string) ClientOption {`
`86`	`89`	`return withScopes(scope)`
`87`	`90`	`}`