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

docs: link from Connection to handshake #3742

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

WhyNotHugo
Copy link
Contributor

When reading the documentation for Connection it is not entirely obvious how instances of this type are obtained. Add a helpful link, mostly for those less familiar.

@tottoto
Copy link
Contributor

tottoto commented Aug 23, 2024

Although I think these links are helpful, having independent sections sounds a bit excessive. How about adding them as inline explanations, similar to the server's documentation?

@WhyNotHugo
Copy link
Contributor Author

Yeah, the new section is pointless. Updated.

When reading the documentation for `Connection` it is not entirely
obvious how instances of this type are obtained. Add a helpful link,
mostly for those less familiar.
@WhyNotHugo
Copy link
Contributor Author

The explicit link was also unnecessary; the handshake function is in the same module.

@tottoto tottoto merged commit 492ab24 into hyperium:master Aug 23, 2024
21 checks passed
@tottoto
Copy link
Contributor

tottoto commented Aug 23, 2024

Thank you!

@WhyNotHugo WhyNotHugo deleted the connection-docs branch August 23, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants