Doc Updates

-update type documentation with operations

Author: ktechhydle

docs/types/builtin.md

@@ -8,6 +8,17 @@ Unique type representing a built-in function included with the language.
 
 Built-in functions are implemented in GLang's Rust backend, meaning they are generally faster and more stable. GLang also includes a set of pre-made functions listed [here](/docs/types/function). There are 12 built-in functions total.
 
+# Operations
+
+## `isbuiltin(value)`
+Returns `true` if `value` is a built-in function.
+
+```
+bark(isfunction(bark)); # true!
+```
+
+# List of Built-Ins
+
 ## `bark(x)`
 Display a value in the terminal.
 

docs/types/function.md

@@ -14,199 +14,11 @@ func example() {
 example(); # call the function
 ```
 
-GLang includes a set of pre-made functions, different from [built-in functions](/docs/types/builtin), as the pre-made functions are written in GLang itself.
-
-## `isnumber(value)`
-Returns `true` if `value` is a number.
-
-```
-obj x = 10;
-
-bark(isnumber(x)); # true!
-```
-
-## `isdecimal(num)`
-Returns `true` if `num` has a decimal place.
-
-```
-obj x = 1.1;
-
-bark(isdecimal(x)); # true!
-```
-
-## `isstring(value)`
-Returns `true` if `value` is a string.
-
-```
-obj x = "This is a string.";
-
-bark(isstring(x)); # true!
-```
-
-## `islist(value)`
-Returns `true` if `value` is a list.
-
-```
-obj x = [1, 2, 3];
-
-bark(islist(x)); # true!
-```
+# Operations
 
 ## `isfunction(value)`
 Returns `true` if `value` is a function.
 
 ```
 bark(isfunction(push)); # true!
 ```
-
-## `isbuiltin(value)`
-Returns `true` if `value` is a built-in function.
-
-```
-bark(isfunction(bark)); # true!
-```
-
-## `push(list, value)`
-Adds the `value` to `list`.
-
-```
-obj x = [1, 2, 3];
-push(x, 4);
-
-bark(x); # output: [1, 2, 3, 4]
-```
-
-## `append(list_a, list_b)`
-Combine a list with another list by copying `list_b`'s elements into `list_a`.
-
-```
-obj x = [1, 2, 3];
-obj y = [4, 5, 6];
-append(x, y);
-
-bark(x); # output: [1, 2, 3, 4, 5, 6]
-```
-
-## `remove(list, index)`
-Removes the value at `index` inside `list` (optionally returns the removed value if necessary).
-
-```
-obj x = [1, 2, 3];
-remove(x, 0);
-
-bark(x); # output: [2, 3]
-```
-
-## `retrieve(list, index)`
-Returns the value at `index` inside `list`.
-
-```
-obj x = [1, 2, 3];
-obj value_in_list = retrieve(x, 0);
-
-bark(value_in_list); # output: 1
-```
-
-## `join(string_a, string_b)`
-Combine two strings together and return the new copy.
-
-```
-obj x = "Hello, ";
-obj y = "world!";
-
-bark(join(x, y)); # output: Hello, world!
-```
-
-## `startswith(str, chars)`
-Returns `true` if `str` begins with `chars`.
-
-```
-obj x = "12345";
-
-bark(startswith(x, "1")); # true!
-```
-
-## `endswith(str, chars)`
-Returns `true` if `str` ends with `chars`.
-
-```
-obj x = "12345";
-
-bark(endswith(x, "5")); # true!
-```
-
-## `charat(str, index)`
-Returns the character at `index` of `string`.
-
-```
-obj x = "12345";
-
-bark(charat(x, 0)); # output: 1
-```
-
-## `clear(value)`
-Clears a list or string and returns a new copy.
-
-### list
-
-```
-obj x = [1, 2, 3, 4];
-obj x = clear(x);
-
-bark(x); # output: []
-```
-
-### string
-
-```
-obj x = "This is a string";
-obj x = clear(x);
-
-bark(x); # output:
-```
-
-## `reverse(value)`
-Reverses a list or string.
-
-- Lists are reversed **in place** (no new copy).
-- Strings are recreated in reverse.
-
-### list
-
-```
-obj x = [1, 2, 3, 4];
-reverse(x);
-
-bark(x); # output: [4, 3, 2, 1]
-```
-
-### string
-
-```
-obj x = "This is a string";
-obj x = reverse(x);
-
-bark(x); # output: gnirts a si sihT
-```
-
-## `contains(value, object)`
-Returns `true` if `value` contains the specified `object`.
-
-- On a string, `object` is treated as the set of characters or substring to search for.
-- On a list, `object` is treated as the element to search for.
-
-### list
-
-```
-obj x = [1, 2, 3, 4];
-
-bark(contains(x, 1)); # true!
-```
-
-### string
-
-```
-obj x = "Hello, World!";
-
-bark(contains(x, "Hello")); # true!
-```

docs/types/list.md

@@ -11,3 +11,84 @@ obj x = [1, 2, 3];
 
 bark(x);
 ```
+
+# Operations
+
+## `islist(value)`
+Returns `true` if `value` is a list.
+
+```
+obj x = [1, 2, 3];
+
+bark(islist(x)); # true!
+```
+
+## `push(list, value)`
+Adds the `value` to `list`.
+
+```
+obj x = [1, 2, 3];
+push(x, 4);
+
+bark(x); # output: [1, 2, 3, 4]
+```
+
+## `append(list_a, list_b)`
+Combine a list with another list by copying `list_b`'s elements into `list_a`.
+
+```
+obj x = [1, 2, 3];
+obj y = [4, 5, 6];
+append(x, y);
+
+bark(x); # output: [1, 2, 3, 4, 5, 6]
+```
+
+## `remove(list, index)`
+Removes the value at `index` inside `list` (optionally returns the removed value if necessary).
+
+```
+obj x = [1, 2, 3];
+remove(x, 0);
+
+bark(x); # output: [2, 3]
+```
+
+## `retrieve(list, index)`
+Returns the value at `index` inside `list`.
+
+```
+obj x = [1, 2, 3];
+obj value_in_list = retrieve(x, 0);
+
+bark(value_in_list); # output: 1
+```
+
+## `contains(list, object)`
+Returns `true` if `list` contains the specified `object`. `object` is treated as the element to search for.
+
+```
+obj x = [1, 2, 3, 4];
+
+bark(contains(x, 1)); # true!
+```
+
+## `reverse(list)`
+Reverses `list` **in place** (no new copy).
+
+```
+obj x = [1, 2, 3, 4];
+reverse(x);
+
+bark(x); # output: [4, 3, 2, 1]
+```
+
+## `clear(list)`
+Clears `list` and returns a new copy.
+
+```
+obj x = [1, 2, 3, 4];
+obj x = clear(x);
+
+bark(x); # output: []
+```

docs/types/number.md

@@ -12,3 +12,23 @@ obj y = 10.0; # decimal
 ```
 
 Each number is stored as a 64 bit floating point, meaning the number type can be stored both as an integer or float.
+
+# Operations
+
+## `isnumber(value)`
+Returns `true` if `value` is a number.
+
+```
+obj x = 10;
+
+bark(isnumber(x)); # true!
+```
+
+## `isdecimal(num)`
+Returns `true` if `num` has a decimal place.
+
+```
+obj x = 1.1;
+
+bark(isdecimal(x)); # true!
+```