Skip to content

Commit 49272ed

Browse files
committed
Add return value documentation to next_instruction
1 parent 69a99e6 commit 49272ed

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/luasm.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ end
443443
--- The function advances `self.ip` until it finds a non‑nil instruction,
444444
--- then calls its `run` method (the executor supplied when the instruction
445445
--- was defined).
446+
--- @return boolean True if the instruction executed correctly
447+
--- False if there is no instruction or the instruction errored out
446448
function interpreter:next_instruction()
447449
::start::
448450

0 commit comments

Comments
 (0)