]> git.lizzy.rs Git - rust.git/commitdiff
Reword module level docs re: alignment
authorDylan MacKenzie <ecstaticmorse@gmail.com>
Tue, 5 Jun 2018 18:22:40 +0000 (11:22 -0700)
committerRalf Jung <post@ralfj.de>
Wed, 29 Aug 2018 08:10:58 +0000 (10:10 +0200)
src/libcore/ptr.rs

index ae7ff78b291305fce2d6bc045d732552b5cdecc0..f15ad7c05cb138ab89e067792ac5790e89637f45 100644 (file)
 //!   freed).
 //! * The pointer satisfies [LLVM's pointer aliasing rules].
 //!
-//! Valid pointers are not necessarily properly aligned. However, except for
-//! [`read_unaligned`] and [`write_unaligned`], most functions require their
-//! arguments to be aligned. Any alignment requirements will be explicitly
-//! stated in the function's documentation.
+//! Valid pointers are not necessarily properly aligned. However, most functions
+//! require their arguments to be properly aligned, and will explicitly state
+//! this requirement in the `Safety` section. Notable exceptions to this are
+//! [`read_unaligned`] and [`write_unaligned`].
 //!
 //! [LLVM's pointer aliasing rules]: https://llvm.org/docs/LangRef.html#pointer-aliasing-rules
 //! [`read_unaligned`]: ./fn.read_unaligned.html