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

Documentation is generated for the empty tokio::net::unix::datagram module #3772

Closed
udoprog opened this issue May 9, 2021 · 1 comment · Fixed by #3775
Closed

Documentation is generated for the empty tokio::net::unix::datagram module #3772

udoprog opened this issue May 9, 2021 · 1 comment · Fixed by #3775
Assignees
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. T-docs Topic: documentation

Comments

@udoprog
Copy link
Contributor

udoprog commented May 9, 2021

Version
1.5.0

Platform
Unix / All (depending on how you look at it)

Description
See: https://docs.rs/tokio/1.5.0/tokio/net/unix/datagram/index.html

All of the relevant types are exported directly in tokio::net already, so this module effectively contains nothing. It might be suitable to make it private.

I'm raising this as an issue, because I'm honestly not sure if this change would count as an API break. Maybe there's some weird macro interaction with a path that wouldn't be happy as a result?

@udoprog udoprog added C-bug Category: This is a bug. T-docs Topic: documentation A-tokio Area: The main tokio crate labels May 9, 2021
@taiki-e taiki-e self-assigned this May 9, 2021
@taiki-e
Copy link
Member

taiki-e commented May 9, 2021

(I think it's unlikely that there is a crate that actually doing that, but if there is a crate doing something similar to old futures (before rust-lang/futures-rs#2299), breakage may occur.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate C-bug Category: This is a bug. T-docs Topic: documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants