Skip to content

Commit 583ce05

Browse files
committed
docs: added text on the return value of var-set
1 parent 8ae82d2 commit 583ce05

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/vm/docs/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ const SET_VAR_API: SpecialAPI = SpecialAPI {
454454
output_type: "bool",
455455
signature: "(var-set var-name expr1)",
456456
description: "The `var-set` function sets the value associated with the input variable to the
457-
inputted value.",
457+
inputted value. The function always returns `true`.",
458458
example: "
459459
(define-data-var cursor int 6)
460460
(var-get cursor) ;; Returns 6

0 commit comments

Comments
 (0)