Better document Box and alloc::alloc::box_free connection
#90723
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
|
r? @kennytm (rust-highfive has picked a reviewer for you, use r? to override) |
|
@bors r+ rollup |
|
📌 Commit db4e60b has been approved by |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 9, 2021
Better document `Box` and `alloc::alloc::box_free` connection The internal `alloc::alloc::box_free` function requires that its signature matches the `owned_box` struct's declaration, but previously that connection was only documented on the `box_free` function. This PR makes the documentation two-way to help anyone making theoretical changes to `Box` to see the connection, since changes are more likely to originate from `Box`.
This was referenced Nov 9, 2021
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 9, 2021
…askrgr Rollup of 7 pull requests Successful merges: - rust-lang#89561 (Type inference for inline consts) - rust-lang#90035 (implement rfc-2528 type_changing-struct-update) - rust-lang#90613 (Allow to run a specific rustdoc-js* test) - rust-lang#90683 (Make `compiler-docs` only control the default instead of being a hard off-switch) - rust-lang#90685 (x.py: remove fixme by deleting code) - rust-lang#90701 (Record more artifact sizes during self-profiling.) - rust-lang#90723 (Better document `Box` and `alloc::alloc::box_free` connection) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The internal
alloc::alloc::box_freefunction requires that its signature matches theowned_boxstruct's declaration, but previously that connection was only documented on thebox_freefunction.This PR makes the documentation two-way to help anyone making theoretical changes to
Boxto see the connection, since changes are more likely to originate fromBox.