2stackz: clarify doc comment on NockStack::reset

Co-authored-by: Jonathan Paprocki <51337059+drbeefsupreme@users.noreply.github.com>
This commit is contained in:
Edward Amsden 2023-12-11 14:16:17 -06:00
parent fc3be96f00
commit 1ee7ce5c32

View File

@ -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) { pub fn reset(&mut self, top_slots: usize) {
self.frame_pointer = unsafe { self.start.add(RESERVED + top_slots) } as *mut u64; self.frame_pointer = unsafe { self.start.add(RESERVED + top_slots) } as *mut u64;
self.stack_pointer = self.frame_pointer; self.stack_pointer = self.frame_pointer;