fix documentation of ptr::dangling() function · qinheping/verify-rust-std@10f64a7 (original) (raw)

Original file line number Diff line number Diff line change
@@ -602,7 +602,7 @@ pub const fn without_provenance(addr: usize) -> *const T {
602 602 unsafe { mem::transmute(addr) }
603 603 }
604 604
605 -/// Creates a new pointer that is dangling, but well-aligned.
605 +/// Creates a new pointer that is dangling, but non-null and well-aligned.
606 606 ///
607 607 /// This is useful for initializing types which lazily allocate, like
608 608 /// `Vec::new` does.
@@ -645,7 +645,7 @@ pub const fn without_provenance_mut(addr: usize) -> *mut T {
645 645 unsafe { mem::transmute(addr) }
646 646 }
647 647
648 -/// Creates a new pointer that is dangling, but well-aligned.
648 +/// Creates a new pointer that is dangling, but non-null and well-aligned.
649 649 ///
650 650 /// This is useful for initializing types which lazily allocate, like
651 651 /// `Vec::new` does.