update documentation for the new quic-go v0.53.0 API#94
Merged
Conversation
fbf54df to
ea6866f
Compare
ea6866f to
545a121
Compare
marten-seemann
commented
Jun 25, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
Updates documentation to align with the new quic-go v0.53.0 API by renaming quic.Connection to quic.Conn, adjusting related examples, and clarifying type references.
- Renamed all occurrences of
quic.Connectiontoquic.Connin code samples and prose - Updated references from interfaces to structs where applicable
- Adjusted wording for consistency (e.g., “endpoints” instead of “implementations”)
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/webtransport/session.md | Renamed quic.Connection to quic.Conn |
| content/docs/quic/streams.md | Updated type references and wording |
| content/docs/quic/server.md | Renamed quic.Connection to quic.Conn in examples |
| content/docs/quic/metrics.md | Updated interface → struct terminology |
| content/docs/quic/datagrams.md | Renamed quic.Connection to quic.Conn |
| content/docs/quic/connection.md | Renamed quic.Connection to quic.Conn |
| content/docs/quic/connection-migration.md | Changed type declaration to *quic.Conn |
| content/docs/quic/client.md | Renamed quic.Connection to quic.Conn |
| content/docs/http3/datagrams.md | Updated comment to use quic.Conn |
Comments suppressed due to low confidence (2)
content/docs/quic/streams.md:7
- [nitpick] For consistency with other docs and to reference the updated API, consider using backticks around the new type name, e.g.,
quic.Conn, instead of the generic “QUIC connection.”
QUIC is a stream-multiplexed transport. A QUIC connection fundamentally differs from the `net.Conn` and the `net.PacketConn` interface defined in the standard library.
content/docs/quic/streams.md:11
- There's a missing “be” in the phrase “can also sent”; it should read “can also be sent.”
In addition to QUIC streams, application data can also sent in so-called QUIC datagram frames (see [datagrams]({{< relref path="datagrams.md" >}})), if endpoints negotiate support for it.
marten-seemann
commented
Jun 25, 2025
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.
No description provided.