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

Rust Docs should not include internal crates #23772

Closed
wycats opened this issue Mar 27, 2015 · 9 comments
Closed

Rust Docs should not include internal crates #23772

wycats opened this issue Mar 27, 2015 · 9 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@wycats
Copy link
Contributor

wycats commented Mar 27, 2015

For example, when I was originally searching for serialize (in the wrong place, I suppose), I got a bunch of internal results. Link to the search.

std_-_rust

@wycats
Copy link
Contributor Author

wycats commented Mar 27, 2015

I also feel that we should not have duplicate core and std entries.

@aturon
Copy link
Member

aturon commented Mar 27, 2015

Paring down what shows up in rustdoc is going to be a key step for 1.0 readiness. Nominating P-high, 1.0 polish.

triage: I-nominated ()

@aturon aturon added A-docs T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Mar 27, 2015
@richo
Copy link
Contributor

richo commented Mar 27, 2015

cc me, ideally there'll be a frob to still specify the old behaviour. rustdoc has been invaluable when I'm spelunking for something.

@aturon
Copy link
Member

aturon commented Mar 27, 2015

@richo Yes indeed, it's important that this is still available in some form for people who want to hack on Rust itself.

@bombless
Copy link
Contributor

I also feel that we should not have duplicate core and std entries.

+1

@tomjakubowski
Copy link
Contributor

I swear there was a pretty old open issue for this already but I can't find it. Also cc #22083 which is important and related.

@tomjakubowski
Copy link
Contributor

I also feel that we should not have duplicate core and std entries.

This would be addressed for the common Rust user by just removing internal crates (including core) from the docs for the release channel. Nightly users, or at least users of core, and people working on the Rust distribution itself are likely going to want to retain item duplication between core and std because it matters to them.

If you initiate your search from std/core then entries in those crates will come first anyway.

@tomjakubowski
Copy link
Contributor

Duplicate of #21297

@emberian
Copy link
Member

I'll have a PR for this soon (it's testing)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

8 participants