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

No documentation for primitives in core #80334

Closed
rossmacarthur opened this issue Dec 23, 2020 · 2 comments
Closed

No documentation for primitives in core #80334

rossmacarthur opened this issue Dec 23, 2020 · 2 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@rossmacarthur
Copy link
Contributor

There is no documentation for primitives in core, the only documentation exists in std. I don't think there is any reason for a user to assume that all associated functions and methods on primitive types that are available in std are also available in core.

Some confusing things:

  • The primitives are not listed in the crate root. See here
  • The core::primitive module documentation primitives have no links. See here
  • The the primitive types modules such as core::i32 link to the std documentation for primitives. See here
@rossmacarthur
Copy link
Contributor Author

@rustbot modify labels: +C-enhancement +T-doc +T-rustdoc +A-rustdoc-ui

@rustbot rustbot added A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Dec 23, 2020
@jyn514
Copy link
Member

jyn514 commented Dec 23, 2020

Duplicate of #73423. See also #62909.

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 A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. 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

3 participants