diff options
| author | nic-gaffney <gaffney_nic@protonmail.com> | 2023-04-18 10:42:45 -0500 |
|---|---|---|
| committer | nic-gaffney <gaffney_nic@protonmail.com> | 2023-04-18 10:42:45 -0500 |
| commit | af02ccd056754c60131d13d74b9fac0e23b2af31 (patch) | |
| tree | 16b041a84a65f2b285192f79e774b15327885bf9 /crates/sloth_vm/src/sloth_std/misc.rs | |
| parent | 38b564380a6362a82a0e5269b1e7e3d3635900e7 (diff) | |
| download | sloth-af02ccd056754c60131d13d74b9fac0e23b2af31.tar.gz | |
Added more documentation in the native functions
Diffstat (limited to 'crates/sloth_vm/src/sloth_std/misc.rs')
| -rw-r--r-- | crates/sloth_vm/src/sloth_std/misc.rs | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/crates/sloth_vm/src/sloth_std/misc.rs b/crates/sloth_vm/src/sloth_std/misc.rs index 72be48f..54d6e37 100644 --- a/crates/sloth_vm/src/sloth_std/misc.rs +++ b/crates/sloth_vm/src/sloth_std/misc.rs @@ -35,5 +35,9 @@ pub const GET_DOC: NativeFunction = NativeFunction { function: get_doc, arity: 1, returns_value: true, - doc: None, + doc: Some( + "NativeFunction get_doc: \n\targs: name (str)\n\tdesc: Returns documentaiton on a \ + function with name <str>\n\tExample: `var doc = get_doc('wait'); # Returns the \ + documentation of the 'wait' function to doc`", + ), }; |