From: Dylan MacKenzie <ecstaticmorse@gmail.com>
Date: Tue, 5 Jun 2018 18:22:40 +0000 (-0700)
Subject: Reword module level docs re: alignment
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=6f7338bb9246abc5078529e218fded18e8766926;p=rust.git

Reword module level docs re: alignment
---

diff --git a/src/libcore/ptr.rs b/src/libcore/ptr.rs
index ae7ff78b291..f15ad7c05cb 100644
--- a/src/libcore/ptr.rs
+++ b/src/libcore/ptr.rs
@@ -25,10 +25,10 @@
 //!   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