Document rewind

brunojppb · May 30, 2024 · b005685 · b005685
1 parent 2d803aa
commit b005685
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/md_parser/src/parser.rs b/md_parser/src/parser.rs
@@ -292,11 +292,15 @@ impl<'source> Parser<'source> {
         return self.previous();
     }
 
+    /// Walk back the given number of steps,
+    /// but never move to a negative position
     fn step_back(&mut self, num_steps: usize) -> Option<&(Token<'source>, Span)> {
         self.current = max(0, self.current - num_steps);
         return self.peek();
     }
 
+    /// Jump straight to an specific position
+    /// with no bounds validation
     fn rewind(&mut self, to_position: usize) {
         self.current = to_position;
     }