Document Box::into_raw returns non-null ptr #53462
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rust-highfive
added
the
S-waiting-on-review
steveklabnik
suggested changes
Aug 18, 2018
src/liballoc/boxed.rs
Outdated
| @@ -126,7 +126,8 @@ impl<T: ?Sized> Box<T> { | |||
| Box(Unique::new_unchecked(raw)) | |||
| } | |||
|
|
|||
| /// Consumes the `Box`, returning the wrapped raw pointer. | |||
| /// Consumes the `Box`, returning the wrapped raw pointer, which | |||
| /// will be properly aligned and non-null. | |||
There was a problem hiding this comment.
So, rustdoc uses the first line as a summary, and this ends up being a bit long. Could you maybe change it to
/// Consumes the `Box<T>`, returning a raw pointer.
///
/// The pointer will be properly aligned and non-null.
There was a problem hiding this comment.
Thanks @steveklabnik, I didn't know that.
|
@bors: r+ rollup |
|
📌 Commit de35b66 has been approved by |
bors
added
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Aug 21, 2018
Document Box::into_raw returns non-null ptr Closes rust-lang#52806.
bors
added a commit
that referenced
this pull request
Aug 21, 2018
Rollup of 17 pull requests Successful merges: - #53030 (Updated RELEASES.md for 1.29.0) - #53104 (expand the documentation on the `Unpin` trait) - #53213 (Stabilize IP associated constants) - #53296 (When closure with no arguments was expected, suggest wrapping) - #53329 (Replace usages of ptr::offset with ptr::{add,sub}.) - #53363 (add individual docs to `core::num::NonZero*`) - #53370 (Stabilize macro_vis_matcher) - #53393 (Mark libserialize functions as inline) - #53405 (restore the page title after escaping out of a search) - #53452 (Change target triple used to check for lldb in build-manifest) - #53462 (Document Box::into_raw returns non-null ptr) - #53465 (Remove LinkMeta struct) - #53492 (update lld submodule to include RISCV patch) - #53496 (Fix typos found by codespell.) - #53521 (syntax: Optimize some literal parsing) - #53540 (Moved issue-53157.rs into src/test/ui/consts/const-eval/) - #53551 (Avoid some Place clones.) Failed merges: r? @ghost
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #52806.
r? @sfackler