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

In some cases, types reexported out of private modules do not show up in rustdoc #24296

Closed
carllerche opened this issue Apr 10, 2015 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@carllerche
Copy link
Member

In the Bytes lib I re-export some structs out of private modules, but for some reason they don't show up in the generated docs.

Reexport: /~https://github.com/carllerche/bytes/blob/40f1d1aa77f0fce11da943b67b408e29f05eb893/src/lib.rs#L25

Docs (though kind of sad): /~https://github.com/carllerche/bytes/blob/master/src/str/bytes.rs#L8

Rustdoc: http://carllerche.github.io/bytes/bytes/index.html

@alexcrichton alexcrichton added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 10, 2015
@fhartwig
Copy link
Contributor

This seems to have been fixed, though I don't know how/when. Making the buf and str modules of the bytes crate private, I can't reproduce this problem any more (on nightly). The struct docs now get "inlined" into the crate root, which is probably what we want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

4 participants