From 6022968c95d5c84fdbb7ecff7ecbc0346d46e60c Mon Sep 17 00:00:00 2001
From: Nick Fitzgerald <fitzgen@gmail.com>
Date: Fri, 9 Feb 2024 08:32:34 -0800
Subject: [PATCH] Add doc comment for helper function

---
 src/lib.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/lib.rs b/src/lib.rs
index e78b1c9..600f6ad 100755
--- 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);