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

Internal crates are documented for stable but not nightly #27149

Closed
SimonSapin opened this Issue Jul 20, 2015 · 4 comments

Comments

Projects
None yet
4 participants
@SimonSapin
Copy link
Contributor

SimonSapin commented Jul 20, 2015

https://doc.rust-lang.org/stable/std/ documents many crates including rustc and syntax, whereas https://doc.rust-lang.org/nightly/std/ only has std and its dependencies. This seems backwards, and opposite of what the commit message for e64b677 / #23848 says.

CC @cmr

@pnkfelix

This comment has been minimized.

Copy link
Member

pnkfelix commented Jul 20, 2015

@SimonSapin from reading the dialogue on #23848, it seems like the purpose of that PR shifted over time: at first it was turning off doc-generation for a broad class of crates, both the compiler-internal ones and the ones hidden behind the std-facade.

But it was determined that turning off doc-generation for the crates behind the std-facade caused links to break, so that doc-generation was turned back on.

So, the end net result of #23848 (if you count the backout commit that landed later) seems to be just to turn off doc generation for the compiler crates alone, I think?

@SimonSapin

This comment has been minimized.

Copy link
Contributor Author

SimonSapin commented Jul 20, 2015

turn off doc generation for the compiler crates alone

That sounds fine, but doing it on nigthly but not on stable?

@SimonSapin

This comment has been minimized.

Copy link
Contributor Author

SimonSapin commented Aug 13, 2015

https://doc.rust-lang.org/stable/std/ does not include compiler-internal crates anymore which is at least consistent, but I still think that their documentation is useful when e.g. developing compiler plugins or working on the compiler itself.

I’m not the only one: https://internals.rust-lang.org/t/documentation-for-libsyntax-friends/2498

@brson

This comment has been minimized.

Copy link
Contributor

brson commented Mar 21, 2016

Closing in favor of #29893.

@brson brson closed this Mar 21, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.