docs: improve discoverability of tokio_util::codec module #2523
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Since it was such a small typo I also added a patch that fixes #2468 |
The section on the two traits at the beginning is very busy looking with every instance of AsyncRead and AsyncWrite as a hyper link. With only one instance of each trait name linked the set of links pops in a more useful way.
fixed: - removed repeated "the" - rephrased slightly
Darksonn
requested changes
May 12, 2020
There was a problem hiding this comment.
You have a lot of broken links. Please check out CONTRIBUTING.md for instructions on how to properly build the documentation. The command to build it is:
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
If you use the stable cargo doc command, a lot of the automated link verification will not work. You should also ensure that your nightly install is recent.
- correct links to Encoder/Decoder - fix futures links - fix stream links
|
Dang, I knew I was building the docs wrong! I've fixed the broken links now. |
Darksonn
reviewed
May 13, 2020
Darksonn
added
A-tokio
Darksonn
approved these changes
May 14, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is my attempt at improving the documentation and visibilty of the codec module.
I think directly mentioning that it converts between AsyncRead/AsyncWrite and Sink/Stream in the module description is a little clearer at least.
I also added a section to the
tokio::iomodule describing whatcodecis used for.Fixes #2475