docs(tvix/eval): add doc comment on `compiler::patch_jump` r/4612

Change-Id: Ifdd7b99223d239d955ac7eeeae95db97eb742bf0
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6276
Reviewed-by: grfn <grfn@gws.fyi>
Tested-by: BuildkiteCI

1 files changed, 6 insertions, 0 deletions

diff --git a/tvix/eval/src/compiler/mod.rs b/tvix/eval/src/compiler/mod.rs
index faf67135ed..a7e5ceb32a 100644
--- a/tvix/eval/src/compiler/mod.rs
+++ b/tvix/eval/src/compiler/mod.rs
@@ -859,6 +859,12 @@ impl Compiler {
         self.emit_constant(Value::String(ident.ident_token().unwrap().text().into()));
     }
 
+    /// Patch the jump instruction at the given index, setting its
+    /// jump offset from the placeholder to the current code position.
+    ///
+    /// This is required because the actual target offset of jumps is
+    /// not known at the time when the jump operation itself is
+    /// emitted.
     fn patch_jump(&mut self, idx: CodeIdx) {
         let offset = self.chunk().code.len() - 1 - idx.0;