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.

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

Improve client documentation #607

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve client documentation #607

wants to merge 1 commit into from

Conversation

@AllenX2018
Copy link

@AllenX2018 AllenX2018 commented Jun 30, 2020

Note: Both Dialer.Subprotocols and requestHeader support the filling of sub-protocols. Please choose one of them according to the actual needs.
@AllenX2018
Improve client documentation
50c5546
elithrar
elithrar requested changes Apr 24, 2021
View changes
Copy link
Member

@elithrar elithrar left a comment

See comments.

client.go
@@ -146,6 +146,9 @@ var nilDialer = *DefaultDialer
// non-nil *http.Response so that callers can handle redirects, authentication,
// etcetera. The response body may not contain the entire response and does not
// need to be closed by the application.
//
// Note:Both Dialer.Subprotocols and requestHeader support the filling of subprotocol.
Copy link
Member

@elithrar elithrar Apr 24, 2021

This needs more detail to be useful documentation. What needs?

"Filling" should be "allow you to define sub-protocols."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elithrar elithrar

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
@AllenX2018 @elithrar