Rewrite `pin` module documentation to clarify usage and invariants#116129

Merged

bors merged 34 commits into

rust-lang:masterfrom

fu5ha:better-pin-docs-2

Jan 8, 2024

Commits on Jan 7, 2024

Rewrite `Pin<P>` docs to clarify guarantees and uses

mcy
authored and
Manishearth
committed
mostly done

fu5ha
authored and
Manishearth
committed
Fix examples, finish polishing

fu5ha
authored and
Manishearth
committed
fix broken links

fu5ha
authored and
Manishearth
committed
fix one more broken link

fu5ha
authored and
Manishearth
committed
update doubly linked list commentary and fix links

fu5ha
authored and
Manishearth
committed
improve intro and `Unpin`-related discussion

fu5ha
authored and
Manishearth
committed
improve intro and discussion of pinning as library contract

fu5ha
authored and
Manishearth
committed
improve `Pin` struct docs and add examples

fu5ha
authored and
Manishearth
committed
fix link in footnote

fu5ha
authored and
Manishearth
committed
reword unpin auto impl section

fu5ha
authored and
Manishearth
committed
improve structural Unpin + formatting

fu5ha
authored and
Manishearth
committed
add section on manual owning ptr managed solution via @kpreid

fu5ha
authored and
Manishearth
committed
fix typos

fu5ha
authored and
Manishearth
committed
fix imports

fu5ha
authored and
Manishearth
committed
edit new section for typos and better wording

fu5ha
authored and
Manishearth
committed
fix typos and edit prose

fu5ha
authored and
Manishearth
committed
`Pin<P>` -> `Pin<Ptr>`

fu5ha
authored and
Manishearth
committed
improve `Pin` and `Pin::new` docs

fu5ha
authored and
Manishearth
committed
justify motivation of `Unpin` better

fu5ha
authored and
Manishearth
committed
fix broken link

fu5ha
authored and
Manishearth
committed
update ui tests

fu5ha
authored and
Manishearth
committed
improve `Pin::new_unchecked` docs

fu5ha
authored and
Manishearth
committed
trim section on managed-box model

fu5ha
authored and
Manishearth
committed
Rephrase unpin docs in terms of pinning-agnosticness
Manishearth
committed
lifetime -> lifespan where relevant. improve docs on as_ref()
Manishearth
committed
Clean up guarantees wording
Manishearth
committed
Apply suggestions from code review

committed
punctuation in parens
Manishearth
committed
valid
Manishearth
committed
footnote on dropping futures
Manishearth
committed
clean up structural pinning
Manishearth
committed
Update library/core/src/pin.rs

Manishearth
and
RalfJung
committed
link
Manishearth
committed