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

rustdoc: missing docs for core::ptr::{copy, copy_nonoverlapping, write_bytes} #64539

Closed
RalfJung opened this issue Sep 17, 2019 · 0 comments · Fixed by #71454
Closed

rustdoc: missing docs for core::ptr::{copy, copy_nonoverlapping, write_bytes} #64539

RalfJung opened this issue Sep 17, 2019 · 0 comments · Fixed by #71454
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@RalfJung
Copy link
Member

The copy, copy_nonoverlapping and write_bytes methods are exposed both via core::ptr and std::ptr. In fact, std::ptr as just a re-export of core::ptr.

However, when comparing the two pages, core::ptr is missing a few items compared to std::ptr: copy, copy_nonoverlapping and write_bytes for some reason are not shown as "functions".

I just realized that thy are shown as "reexports". So likely I could have made rust-lang/nomicon#165 link to the versions in core::intrinsics instead. But we don't actually want people to use those paths, they are available on stable only due to a bug. We'd prefer if people used these symbols through ptr, but then it seems we have to link to std::ptr, which is somewhat annoying.
@RalfJung RalfJung added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 17, 2019
@jonas-schievink jonas-schievink added the C-bug Category: This is a bug. label Sep 17, 2019
@ecstatic-morse ecstatic-morse mentioned this issue Apr 23, 2020
Merged
JohnTitor added a commit to JohnTitor/rust that referenced this issue Apr 23, 2020
@JohnTitor
Rollup merge of rust-lang#71454 - ecstatic-morse:inline-core-ptr-docs…
e20df27 
…, r=RalfJung

Inline some function docs in `core::ptr`

Resolves rust-lang#64539.
@bors bors closed this as completed in 98cadb2 Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Inline some function docs in core::ptr ecstatic-morse/rust
2 participants
@RalfJung @jonas-schievink