Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document limitation of WithUserAgent #1747

Merged
merged 2 commits into from Nov 10, 2022
Merged

docs: document limitation of WithUserAgent #1747

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e13246
docs: document limitation of WithUserAgent
codyoss Nov 9, 2022
a1365a6
Merge branch 'main' into add-some-clarity
codyoss Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion option/option.go
View file
Open in desktop
Expand Up @@ -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)
}
Expand Down