Add doc comment for helper function

fitzgen · Feb 9, 2024 · 6022968 · 6022968
1 parent e7d0d15
commit 6022968
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -420,6 +420,7 @@ pub(crate) fn round_down_to(n: usize, divisor: usize) -> usize {
     n & !(divisor - 1)
 }
 
+/// Same as `round_down_to` but preserves pointer provenance.
 #[inline]
 pub(crate) fn round_mut_ptr_down_to(ptr: *mut u8, divisor: usize) -> *mut u8 {
     debug_assert!(divisor > 0);