hyperium / hyper

An HTTP library for Rust
https://hyper.rs
MIT License
14.42k stars 1.59k forks source link

docs: link from Connection to handshake #3742

Closed WhyNotHugo closed 1 month ago

WhyNotHugo commented 1 month ago

When reading the documentation for Connection it is not entirely obvious how instances of this type are obtained. Add a helpful link, mostly for those less familiar.

tottoto commented 1 month ago

Although I think these links are helpful, having independent sections sounds a bit excessive. How about adding them as inline explanations, similar to the server's documentation?

WhyNotHugo commented 1 month ago

Yeah, the new section is pointless. Updated.

WhyNotHugo commented 1 month ago

The explicit link was also unnecessary; the handshake function is in the same module.

tottoto commented 1 month ago

Thank you!