Skip to content

add std and core to nightly-rustc docs #130955

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

Open
lolbinarycat opened this issue Sep 27, 2024 · 3 comments
Open

add std and core to nightly-rustc docs #130955

lolbinarycat opened this issue Sep 27, 2024 · 3 comments
Labels
C-discussion Category: Discussion or questions that doesn't represent real issues. C-feature-request Category: A feature request, i.e: not implemented / a PR.

Comments

@lolbinarycat
Copy link
Contributor

the rustc internal api docs differ from the main std docs in two major ways:

  1. documenting different crates
  2. showing private items

being able to see std-internal items would be quite handy for anyone developing the standard library.

@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 27, 2024
@ChrisDenton
Copy link
Member

In the past there's been concern about it showing up in search results and people getting confused. That's one reason why the third party stdrs.dev has a big red warning sign.

@saethlin saethlin added C-feature-request Category: A feature request, i.e: not implemented / a PR. C-discussion Category: Discussion or questions that doesn't represent real issues. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Sep 27, 2024
@lolbinarycat
Copy link
Contributor Author

there should probably be some sort of heading on the nightly-rustc docs, yeah.

the fact that there's no heading means i kinda just have to refer to them by the url.

generally speaking, documentation doesn't link to other docs enough.

@jieyouxu
Copy link
Member

jieyouxu commented Sep 28, 2024

I actually do like the current setup where nightly rustc crates + tool crates + bootstrap docs get their own search subsite that is independent from std docs. It's already quite difficult at times to find something inside compiler or tools through search, I wouldn't want those search results to also include std things. That is, I actually prefer the current setup where:

  • Rustc, tools and bootstrap get their nightly-rustc subsite https://doc.rust-lang.org/nightly/nightly-rustc/ which includes --document-private-items, and
  • Std get its own nightly subsite like <stdrs.dev> (though we can "officially" build those too FWIW).

Unless there's already an easy way in rustdoc to restrict where results from come.

EDIT: I would be perfectly fine with building them together if we have multi-crate search result filters #130971.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-discussion Category: Discussion or questions that doesn't represent real issues. C-feature-request Category: A feature request, i.e: not implemented / a PR.
Projects
None yet
Development

No branches or pull requests

5 participants