Documentation doesn't explain that path and query are omitted from the call to `call`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.3k
- Forks
- 1.8k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 14
Description
[Note: Verified on 13.10, haven't been able to try with 14.x yet]
When implementing a https://docs.rs/hyper/0.13.10/hyper/client/connect/index.html the documentation says:
A "connector" is a Service that takes a Uri destination, and its Response is some type implementing AsyncRead, AsyncWrite, and Connection.
This is a bit misleading -- specifically, the Uri that it receives is not the Uri that the request is for -- the path and query part appear to be stripped, leaving just the schema and the authority.
I think this is because, for connection pooling, only the scheme and authority are considered as part of the hash key.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the hyper client/connect documentation referenced in the issue and compare its description of the connector Service with the observed behavior in 0.13.10. Update the documentation to state that the connector receives only the scheme and authority, with path and query omitted, and clarify the connection-pooling context if supported by the existing text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100