Skip to content

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

Merged
merged 3 commits into from
Jun 25, 2025

Conversation

marten-seemann
Copy link
Member

No description provided.

@marten-seemann marten-seemann requested a review from Copilot June 24, 2025 16:09
Copilot

This comment was marked as outdated.

Copilot

This comment was marked as outdated.

@marten-seemann marten-seemann requested a review from Copilot June 25, 2025 03:04
Copy link
Contributor

@Copilot Copilot AI left a 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 to quic.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.

@marten-seemann marten-seemann merged commit 13c41d8 into master Jun 25, 2025
1 check passed
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.

1 participant