Skip to content
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

Fix documentation link to codec module/crate #5825

Closed
marcospb19 opened this issue Jun 27, 2023 · 1 comment · Fixed by #5849
Closed

Fix documentation link to codec module/crate #5825

marcospb19 opened this issue Jun 27, 2023 · 1 comment · Fixed by #5849
Labels
A-tokio-util Area: The tokio-util crate C-bug Category: This is a bug. E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. M-io Module: tokio/io T-docs Topic: documentation

Comments

@marcospb19
Copy link
Contributor

I wanted to use the counterpart tokio_util::io::SinkWriter but there's none, instead the docs point to "codec" but the link is broken.

Codec link can be found here:

https://docs.rs/tokio-util/latest/tokio_util/io/struct.SinkWriter.html

Or here:

/// The opposite conversion of implementing `Sink<_>` for an [`AsyncWrite`]
/// is done using the [`codec`] module.


I believe the link could point to tokio_codec::BytesCodec instead, but I'm not sure.

@marcospb19 marcospb19 added A-tokio Area: The main tokio crate C-bug Category: This is a bug. labels Jun 27, 2023
@Darksonn Darksonn added T-docs Topic: documentation A-tokio-util Area: The tokio-util crate M-io Module: tokio/io E-help-wanted Call for participation: Help is requested to fix this issue. E-easy Call for participation: Experience needed to fix: Easy / not much and removed A-tokio Area: The main tokio crate labels Jun 27, 2023
@Darksonn
Copy link
Contributor

To fix this, replace tokio_util with crate in the link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio-util Area: The tokio-util crate C-bug Category: This is a bug. E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. M-io Module: tokio/io T-docs Topic: documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants