doc(Unscan): Clarify that it doesn't move the token

uber-go · Oct 22, 2023 · aee45b6 · aee45b6
1 parent 6396c7f
commit aee45b6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/internal/stack/scan.go b/internal/stack/scan.go
@@ -46,7 +46,8 @@ func (s *scanner) Scan() bool {
 	return s.Scanner.Scan()
 }
 
-// Unscan moves the scanner back one token.
+// Unscan stops the scanner from advancing its position
+// for the next Scan.
 //
 // Bytes and Text will return the same token after next Scan
 // that they do right now.