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

Docs don't include public structures #41

Closed
geofft opened this issue Sep 24, 2015 · 4 comments
Closed

Docs don't include public structures #41

geofft opened this issue Sep 24, 2015 · 4 comments

Comments

@geofft
Copy link

geofft commented Sep 24, 2015

For instance, ByteBuf certainly looks like it's trying to be publicly documented, but it's not showing up in the rustdoc. All you see is a list of re-exports from private modules.

@fhartwig
Copy link
Contributor

That's a bug in rustdoc. @carllerche has filed an issue. I've been meaning to look into this, but I haven't gotten around to it yet.
If you need a workaround, you can make the buf and str modules public and then build the docs locally.

@carllerche
Copy link
Member

I worked around by making buf and str public since it doesn't seem like the issue is getting any love :(

@fhartwig
Copy link
Contributor

The rustdoc bug seems to have been fixed. If I make buf and str private and build the docs with the current nightly, all the structs are included in the docs.

@carllerche
Copy link
Member

Hmm... I don't actually dislike keeping the modules public now. I may remove the root re-exports. Unsure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants