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.

Sign up for GitHub

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

Jump to bottom

Move primitive docs to core #83624

Closed
camelid opened this issue Mar 28, 2021 · 2 comments
Closed

Move primitive docs to core #83624

camelid opened this issue Mar 28, 2021 · 2 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-discussion Category: Discussion or questions that doesn't represent real issues. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Mar 28, 2021

Rust primitives are currently documented in std, but in some cases we want to link to primitives from core (cc #83577). Also, core seems like it would be a better place to document primitives since they are available in programs that are no_std (yes, they're also available in no_core programs, but we have to put the docs somewhere).

We would probably have to re-export the primitives in std (and alloc too?) so as not to break links.

What do you (T-rustdoc, T-libs) think?

cc @rust-lang/rustdoc
@camelid camelid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-libs-api Relevant to the library API 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-discussion Category: Discussion or questions that doesn't represent real issues. labels Mar 28, 2021
@jyn514
Copy link
Member

jyn514 commented Mar 29, 2021

This has been discussed before in #73423, I would rather keep discussion in one issue.

@jyn514 jyn514 closed this as completed Mar 29, 2021
@camelid
Copy link
Member Author

camelid commented Mar 29, 2021

Sounds good, I didn't know if there was a previous issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-discussion Category: Discussion or questions that doesn't represent real issues. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jyn514 @camelid