Added documentation to Program. Closes #535

dop251 · Oct 10, 2023 · acb9272 · acb9272
1 parent fc55792
commit acb9272
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/compiler.go b/compiler.go
@@ -63,6 +63,9 @@ type srcMapItem struct {
 	srcPos int
 }
 
+// Program is an internal, compiled representation of code which is produced by the Compile function.
+// This representation is not linked to a runtime in any way and can be used concurrently.
+// It is always preferable to use a Program over a string when running code as it skips the compilation step.
 type Program struct {
 	code   []instruction
 	values []Value