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

Generate a documentation page for core::mem::transmute. #57848

Merged
merged 2 commits into from
Feb 7, 2019
Merged

Generate a documentation page for core::mem::transmute. #57848

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c54d2d
Mention that core::intrinsics::transmute is available at core::mem::t…
jrvanwhy Jan 22, 2019
1c8c94a
Instead of adding a paragraph mentioning std::mem::transmute and core…
jrvanwhy Jan 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/libcore/intrinsics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,6 +729,10 @@ extern "rust-intrinsic" {
/// cause [undefined behavior][ub] with this function. `transmute` should be
/// the absolute last resort.
///
/// `transmute` is re-exported by [core::mem](../mem/index.html) as
/// `core::mem::transmute`, which may be used without the `core_intrinsics`
/// feature flag.
Copy link
Member

@scottmcm scottmcm Jan 24, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs are going to show up for all four of {core|std}::{mem|intrinsics}::transmute, right? It might be worth pointing at both mem locations, in that case.

///
/// The [nomicon](../../nomicon/transmutes.html) has additional
/// documentation.
///
Expand Down