docs: add detailed description of the quic package #3902
Merged
Conversation
This file contains 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
marten-seemann
force-pushed
the
docs-update-readme
branch
from
dccd2c0
to
868e0ec
Compare
Codecov Report
@@ Coverage Diff @@
## master #3902 +/- ##
==========================================
+ Coverage 83.13% 84.12% +0.99%
==========================================
Files 145 145
Lines 14600 14903 +303
==========================================
+ Hits 12137 12536 +399
+ Misses 1981 1892 -89
+ Partials 482 475 -7 |
p-shahi
reviewed
Jun 15, 2023
README.md
Outdated
|
|
||
| go test ./... | ||
| The central entry point is the `quic.Transport`. A transport manages QUIC connections running on a single UDP socket. Since QUIC uses Connection IDs, it can demultiplex a listener (accepting incoming connections) and an arbitrary number of outgoing connections on the same UDP socket. |
There was a problem hiding this comment.
Suggested change
| The central entry point is the `quic.Transport`. A transport manages QUIC connections running on a single UDP socket. Since QUIC uses Connection IDs, it can demultiplex a listener (accepting incoming connections) and an arbitrary number of outgoing connections on the same UDP socket. | |
| The central entry point is the `quic.Transport`. A transport manages QUIC connections running on a single UDP socket. Since QUIC uses Connection IDs, it can demultiplex a listener (accepting incoming connections) and an arbitrary number of outgoing connections on the same UDP socket. |
"and an arbitrary number of outgoing connections on the same UDP socket"
missed a word after and an ?
There was a problem hiding this comment.
Not sure I understand the comment, even after re-reading the sentence for 10 sentences. I added "QUIC connections", hope that clarifies things.
lucas-clemente
approved these changes
Jun 20, 2023
Co-authored-by: Prithvi Shahi <[email protected]>
marten-seemann
force-pushed
the
docs-update-readme
branch
from
8f0f345
to
17795e4
Compare
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.
Left for follow-up work: