]> git.lizzy.rs Git - rust.git/commit
Rollup merge of #90723 - asquared31415:box_docs, r=jyn514
authorMatthias Krüger <matthias.krueger@famsik.de>
Tue, 9 Nov 2021 18:00:46 +0000 (19:00 +0100)
committerGitHub <noreply@github.com>
Tue, 9 Nov 2021 18:00:46 +0000 (19:00 +0100)
commit9c1aa12ff11257c8a149b76e21e3cccac1893350
tree51d3d43f806a176d21562fb0de88232642631cf2
parentfd5a4f42ad425a19c022fcafe482341e2612f29e
parentdb4e60b29f863bbf78351b7f095b221ffe7b93a6
Rollup merge of #90723 - asquared31415:box_docs, r=jyn514

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`.