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: Hide nightly-only messages on doc.rust-lang.org/nightly-rustc #54682

Closed
Havvy opened this issue Sep 29, 2018 · 4 comments · Fixed by #74351
Closed

Docs: Hide nightly-only messages on doc.rust-lang.org/nightly-rustc #54682

Havvy opened this issue Sep 29, 2018 · 4 comments · Fixed by #74351
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Havvy
Copy link
Contributor

Havvy commented Sep 29, 2018

When reading the nightly-rustc docs, all the yellow boxes saying they're experimental is entirely noise. It'd be nice to remove them.

@Havvy Havvy added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. labels Sep 29, 2018
@Havvy
Copy link
Contributor Author

Havvy commented Sep 29, 2018

I'm putting both T-Doc and T-Rustdoc, but I'm not sure which teams this falls under.

@steveklabnik
Copy link
Member

steveklabnik commented Sep 29, 2018 via email

@Havvy
Copy link
Contributor Author

Havvy commented Sep 29, 2018

That makes sense on core, std, and alloc, but rustc_nightly is all implementation details. It's placed on literally everything on https://doc.rust-lang.org/nightly/nightly-rustc/syntax/parse/struct.ParseSess.html#method.buffer_lint when there's no reason to expect to be able to use the struct at all in stable Rust. A top level notification that it's the internal docs might not go amiss, but this is a bit excessive.

@Mark-Simulacrum
Copy link
Member

I think it makes more sense to stop shipping nightly-rustc as part of the stable and beta toolchains, presuming we do so today.

Having said that, I could see the usecase for telling rustdoc "this set if features is enabled already" such that we could whitelist rustc_private for the compiler docs.

@steveklabnik steveklabnik removed the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Dec 27, 2018
@bors bors closed this as completed in 0e70884 Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants