diff options
Diffstat (limited to 'crates/sloth_vm/src/sloth_std/rand.rs')
| -rw-r--r-- | crates/sloth_vm/src/sloth_std/rand.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/crates/sloth_vm/src/sloth_std/rand.rs b/crates/sloth_vm/src/sloth_std/rand.rs index bae0606..870cca1 100644 --- a/crates/sloth_vm/src/sloth_std/rand.rs +++ b/crates/sloth_vm/src/sloth_std/rand.rs @@ -16,6 +16,10 @@ pub const GEN_FUNCTION: NativeFunction = NativeFunction { function: gen, arity: 0, returns_value: true, + doc: Some( + "NativeFunction rand$gen:\n\tdesc: Returns a random number in the range `0.0 .. \ + 1.0`\n\tExample: `var num = rand$gen(); # num could be any number from 0.0 to 1.0`", + ), }; fn gen_range(_vm: &mut VM, args: &[Primitive]) -> NativeFunctionResult { @@ -36,4 +40,9 @@ pub const GEN_RANGE_FUNCTION: NativeFunction = NativeFunction { function: gen_range, arity: 2, returns_value: true, + doc: Some( + "NativeFunction rand$gen_range: \n\targs: min (int), max (int)\n\tdesc: Returns a random \ + numnber in the range <min> .. <max>\n\tExample: `var num = rand$gen_range(20, 76); # num \ + could be any number from 20 to 76`", + ), }; |