update documentation for Transport.ConnContext#92
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for Transport.ConnContext to reflect its new signature introduced in v0.52.0.
- Updated the function signature in the code sample to include an additional parameter and return an error.
- Added a callout section explaining how returning an error can reject a connection attempt.
Comments suppressed due to low confidence (1)
content/docs/quic/connection.md:21
- [nitpick] Consider adding a brief inline comment to explain the purpose of the new 'info' parameter to improve clarity for readers of the documentation.
ConnContext: func(ctx context.Context, info *quic.ClientInfo) (context.Context, error) {
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
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.
This was introduced by @sukunrt in quic-go/quic-go#5122 and released in v0.52.0.