Document internal unsafety #173
Labels
A-docs
Area: documentation for any part of the project.
C-bug
Category: Bug
E-needs-docs
Needs documentation added.
Currently, we document public
unsafe fn
and their invariants.However, as a highly
unsafe
crate, we should also document internally that we are maintaining invariants forunsafe
blocks internally. That said, we are also sounsafe
because almost everything is a thin wainscotting overextern "platform-intrinsic"
calls. Those are not the focus of this issue. Rather, what we really want to document is anything that isn't just a straight pass-through to an internalunsafe fn
intrinsic. These comments need not be publically exposed.A few of these were surfaced in https://github.com/rust-lang/portable-simd/pull/172/files. Mostly, it's things like our internal implementation of existing trait-level
unsafe fn
. Also we should probably document the safety invariants on theimpl
too, not just on the trait.The text was updated successfully, but these errors were encountered: