-
-
Notifications
You must be signed in to change notification settings - Fork 4
update documentation for the new quic-go v0.53.0 API #94
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
Conversation
fbf54df
to
ea6866f
Compare
ea6866f
to
545a121
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.Connection
toquic.Conn
in 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.
No description provided.