update docs comment

use-ink · Feb 22, 2024 · da598d3 · da598d3
1 parent 815edee
commit da598d3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/.config/cargo_spellcheck.dic b/.config/cargo_spellcheck.dic
@@ -25,6 +25,7 @@ Wasm32
 WebAssembly
 adjunctive
 bitvector
+bitmask
 bitwise
 callee
 codegen

diff --git a/crates/allocator/src/bump.rs b/crates/allocator/src/bump.rs
@@ -202,8 +202,10 @@ impl InnerAlloc {
     /// of a layout in the linear memory.
     /// - Initially `self.next` is `0`` and aligned
     /// - `layout.align() - 1` accounts for `0` as the first index.
-    /// - the binary with the inverse of the align ensures
-    /// that the next allocated pointer address is of the power of 2.
+    /// - the binary with the inverse of the align creates a
+    /// bitmask that is used to zero out bits, ensuring alignment according to type
+    /// requirements and ensures that the next allocated pointer address is of the
+    /// power of 2.
     fn align_ptr(&self, layout: &Layout) -> usize {
         (self.next + layout.align() - 1) & !(layout.align() - 1)
     }