Skip to content

stable rustdoc should prune unstable items from stdlib docs #31156

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

Closed
tomjakubowski opened this issue Jan 24, 2016 · 1 comment
Closed

stable rustdoc should prune unstable items from stdlib docs #31156

tomjakubowski opened this issue Jan 24, 2016 · 1 comment

Comments

@tomjakubowski
Copy link
Contributor

For example, http://doc.rust-lang.org/std/error/trait.Error.html includes impls for unstable structs like std::ffi::IntoStringError. Like #31098, this is "dangling a carrot" which users of stable rust can't reach! I think that the doc page for IntoStringError shouldn't exist in the set of stable docs.

There are already passes to strip things like #[doc(hidden)] and private items from the crate before generating documentation. The same could be done for unstable items.

@tomjakubowski
Copy link
Contributor Author

Okay, I see this is a dupe of #25863. I don't think it's true that the set of unstable items is small, but I'll close this issue.

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

1 participant