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

Term and getopt crates show in the standard library documentation #49388

Closed
matthewjasper opened this issue Mar 26, 2018 · 9 comments
Closed
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. regression-from-stable-to-beta Performance or correctness regression from stable to beta.

Comments

@matthewjasper
Copy link
Contributor

These crates were added by #48588, but should probably be hidden. See https://doc.rust-lang.org/nightly/term/index.html.

@pietroalbini pietroalbini added C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Mar 27, 2018
@QuietMisdreavus
Copy link
Member

@Mark-Simulacrum How do crates get included in the std docs? I thought other private dependencies were already being excluded.

@Mark-Simulacrum
Copy link
Member

I don't see it being built locally so it's probably an old version of term, though I'm not certain. We'd have to figure out whether these are a recent-ish version and go from there, probably...

@Mark-Simulacrum
Copy link
Member

Oh, these aren't from std's docs I think -- but rather tests' docs. I don't know if it's actually too much of a problem and am somewhat inclined to just leave it, but I suppose we could fix it if necessary. Should just be a matter of adding -p test to the invocation of Cargo here:https://github.com/rust-lang/rust/blob/master/src/bootstrap/doc.rs#L556

@ollie27
Copy link
Member

ollie27 commented Mar 27, 2018

This was triggered by #49193. The docs for test are currently only built when the compiler docs are enabled. The question is do we want the docs for the test crate included with the std docs or the compiler docs?

@GuillaumeGomez
Copy link
Member

I just built the docs once again and didn't have the problem. I suppose the issue can therefore be closed.

@ollie27
Copy link
Member

ollie27 commented Mar 27, 2018

@GuillaumeGomez you need to enable the compiler docs to reproduce this.

@GuillaumeGomez
Copy link
Member

You mean besides running ./x.py doc --stage 1?

@ollie27
Copy link
Member

ollie27 commented Mar 29, 2018

Yeah, you need to have compiler-docs = true in your config.toml. Anyway I've submitted #49465 to fix this.

@ollie27
Copy link
Member

ollie27 commented Apr 5, 2018

Could this be reopened? It is clearly not fixed: https://doc.rust-lang.org/nightly/term/index.html. This could also do with a regression-from-stable-to-beta tag as it affects beta now: https://doc.rust-lang.org/beta/term/index.html.

@GuillaumeGomez GuillaumeGomez reopened this Apr 5, 2018
@GuillaumeGomez GuillaumeGomez added the regression-from-stable-to-beta Performance or correctness regression from stable to beta. label Apr 5, 2018
kennytm added a commit to kennytm/rust that referenced this issue Apr 14, 2018
…eklabnik,QuietMisdreavus,frewsxcv,GuillaumeGomez

Add docs for the test crate with the std docs

If the compiler docs aren't going to include the test crate then it may as well be included with std.

Fixes rust-lang#49388
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. regression-from-stable-to-beta Performance or correctness regression from stable to beta.
Projects
None yet
Development

No branches or pull requests

6 participants