Skip to content

Commit 29c8358

Browse files
Reword module level docs re: alignment
1 parent 9e93c6b commit 29c8358

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/libcore/ptr.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
//! freed).
2626
//! * The pointer satisfies [LLVM's pointer aliasing rules].
2727
//!
28-
//! Valid pointers are not necessarily properly aligned. However, except for
29-
//! [`read_unaligned`] and [`write_unaligned`], most functions require their
30-
//! arguments to be aligned. Any alignment requirements will be explicitly
31-
//! stated in the function's documentation.
28+
//! Valid pointers are not necessarily properly aligned. However, most functions
29+
//! require their arguments to be properly aligned, and will explicitly state
30+
//! this requirement in the `Safety` section. Notable exceptions to this are
31+
//! [`read_unaligned`] and [`write_unaligned`].
3232
//!
3333
//! [LLVM's pointer aliasing rules]: https://llvm.org/docs/LangRef.html#pointer-aliasing-rules
3434
//! [`read_unaligned`]: ./fn.read_unaligned.html

0 commit comments

Comments
 (0)