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.

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

Documentation improvements #28

Closed
Lukasa opened this issue Oct 11, 2015 · 0 comments
Closed

Documentation improvements #28

Lukasa opened this issue Oct 11, 2015 · 0 comments

Comments

@Lukasa
Copy link
Member

Lukasa commented Oct 11, 2015

Received via email:

  • According to this, Hyper-h2 is an HTTP/2 implementation, so does it make sense to say that it's for "writing fully-fledged HTTP/2 implementations".
  • At first reading, it's not at all clear to me what you mean by the "top" and "bottom" of an H2Connection objection.
  • It seems odd to me that things like "send headers" and "send data" are formatted as code.
  • The five points describing the loop sort of make sense -- but I'm not sure whether it describes anything beyond a normal event loop
  • Before 3.5, socket.listen() requires a backlog argument, so the code in your example doesn't work
  • You should make it clear that the reader should install hyper-h2 alongside installing hyper.
  • When you said "But what we didn’t see was hyper making a request, and hyper was clearly hanging, waiting for something. Why?" it's not clear what the relationship is between us not seeing hyper making a request, and hyper hanging.
  • I reckon it's worth making it clear right at the top that Hyper-h2 doesn’t do any I/O, and it'd be interesting to talk about why.
@Lukasa Lukasa added this to the 1.0.0 milestone Oct 11, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant