Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Transport "Document organization" skips sections #1894

Closed
MikeBishop opened this issue Oct 19, 2018 · 0 comments
Closed

Transport "Document organization" skips sections #1894

MikeBishop opened this issue Oct 19, 2018 · 0 comments
Labels
-transport editorial An issue that does not affect the design of the protocol; does not require consensus.

Comments

@MikeBishop
Copy link
Contributor

Since section 1.1 is effectively a guided tour of the TOC, it feels odd that it skips sections without comment. For example,

Connections are the context in which QUIC endpoints communicate.

  • Section 5 describes core concepts related to connections,
  • Section 6 describes version negotiation,
  • Section 8 details the process for establishing connections,
  • Section 10 describes how endpoints migrate a connection to use a new network paths, and
  • Section 12 lists the options for terminating an open connection.

Where are sections 7, 9, and 11?

I think there's also some unintended irony that error handling is section 13. ;-)
@MikeBishop MikeBishop added editorial An issue that does not affect the design of the protocol; does not require consensus. -transport labels Oct 19, 2018
martinthomson added a commit that referenced this issue Oct 25, 2018
@martinthomson
Add missing sections to document structure
5343b7f 
There were two things that we missed, which looked a little incongrous.
This adds them to avoid the confusion arising from their absence, even
if they don't really need to be there.

Closes #1894.
@martinthomson martinthomson mentioned this issue Oct 25, 2018
Merged
martinthomson added a commit that referenced this issue Oct 29, 2018
@martinthomson
Add missing sections to document structure
4417e03 
There were two things that we missed, which looked a little incongrous.
This adds them to avoid the confusion arising from their absence, even
if they don't really need to be there.

Closes #1894.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
-transport editorial An issue that does not affect the design of the protocol; does not require consensus.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MikeBishop