docs: link from Connection to handshake#3742
Merged
tottoto merged 1 commit intohyperium:masterfrom Aug 23, 2024
Merged
Conversation
Contributor
|
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? |
306d4a9 to
81eda3e
Compare
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.
81eda3e to
9199f1b
Compare
Contributor
Author
|
The explicit link was also unnecessary; the |
tottoto
approved these changes
Aug 23, 2024
Contributor
|
Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When reading the documentation for
Connectionit is not entirely obvious how instances of this type are obtained. Add a helpful link, mostly for those less familiar.