From 1ee7ce5c32a6e05932e958ee58f35902f0edefe7 Mon Sep 17 00:00:00 2001
From: Edward Amsden <edward@blackriversoft.com>
Date: Mon, 11 Dec 2023 14:16:17 -0600
Subject: [PATCH] 2stackz: clarify doc comment on NockStack::reset

Co-authored-by: Jonathan Paprocki <51337059+drbeefsupreme@users.noreply.github.com>
---
 rust/ares/src/mem.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/ares/src/mem.rs b/rust/ares/src/mem.rs
index 9a6352a..873dedd 100644
--- a/rust/ares/src/mem.rs
+++ b/rust/ares/src/mem.rs
@@ -123,7 +123,7 @@ impl NockStack {
         }
     }
 
-    /** Resets the NockStack. */
+    /** Resets the NockStack. The top frame is west as in the initial creation of the NockStack. */
     pub fn reset(&mut self, top_slots: usize) {
         self.frame_pointer = unsafe { self.start.add(RESERVED + top_slots) } as *mut u64;
         self.stack_pointer = self.frame_pointer;