-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Polish the API docs #3067
Comments
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
I'm going through the currently rendered docs (of rc4) and writing down some notes in the top comment about what needs to be improved. By making them separate items in a task list, it should be easy to convert any single one into an issue. If you'd like to fix any, start a pull request mentioning it, and I'll click the button to convert the task into an issue. An item tagged with 👀 means I haven't yet analyzed the module or its types. |
And explain that users don't "create" one. cc #3067
And explain that users don't "create" one. cc hyperium#3067
And explain that users don't "create" one. cc hyperium#3067 Signed-off-by: Sven Pfennig <s.pfennig@reply.de>
This is issue about what appears at https://docs.rs/hyper. As a general rule, we should incrementally improve them with the following in mind:
Items to document
conn
: 👀Protocol
: explain that it is for http/2, what it does, that it must be used with associated builder options, show exampleReasonPhrase
unstable
tagconn
module: mention hyper-util providing anAutoConnection
and builderconn::http1
module: provide an overview, and a getting started sectionconn::http1::Builder
: Provide an example constructing one and setting some options.conn::http1::Connection
: Explain that this is returned fromBuilder::serve_connection
, and that it is essential animpl Future
that must be polled (orawait
ed) for anything to happen.conn::http2
module: provide an overview, and a getting started sectionThe text was updated successfully, but these errors were encountered: