docs(client): improve warnings and links in client doc comments #540
Conversation
kylebarron
left a comment
kylebarron
left a comment
There was a problem hiding this comment.
Thanks! Looks mostly good to me
src/client/mod.rs
Outdated
| /// | ||
| /// This is on by default, since http2 is known to be significantly slower than http1. | ||
| /// # See Also | ||
| /// * [`Self::with_http2_only`] if you only want to use http2 |
There was a problem hiding this comment.
I think it would probably be good to have consistent casing of HTTP1 and HTTP2
There was a problem hiding this comment.
Changing the instances of the lowercased httpX is consistent with how we currently do doc comments.
Fixing the Spelling/punctuation is fine though. I fixed it in my last PR to HTTP/X which is used in the spec.
alamb
changed the title
|
Love it -- thank you @CommanderStorm and @kylebarron |
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you @CommanderStorm -- I think @kylebarron suggestions are spot on. I also left a few suggestions. Let us know what you think!
CommanderStorm
left a comment
CommanderStorm
left a comment
There was a problem hiding this comment.
Sorry for the long wait from my side
Co-authored-by: Andrew Lamb <[email protected]>
No problems! Thank you for the contribution |
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Thank you @CommanderStorm -- this looks like a great improvement to me
I am also interested to see what @kylebarron thinks too
|
I took the liberty of running |
3 participants
Which issue does this PR close?
None, it is a cosmetic docs change.
Rationale for this change
Looking though the client docs I noticed that some parts could be more consistent and others could be more highlighted.
This PR improves the docs in this department.
What changes are included in this PR?
Changes like this:
Are there any user-facing changes?
🤷🏻♂️ It is only in the docs. Depends if you consider this user-facing. Likely yes. 😉