diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/common.md | 22 | ||||
| -rw-r--r-- | docs/crypto.md | 2 | ||||
| -rw-r--r-- | docs/io.md | 2 | ||||
| -rw-r--r-- | docs/math.md | 2 | ||||
| -rw-r--r-- | docs/readme.md | 16 | ||||
| -rw-r--r-- | docs/table.md | 2 | ||||
| -rw-r--r-- | docs/thread.md | 2 |
7 files changed, 26 insertions, 22 deletions
diff --git a/docs/common.md b/docs/common.md deleted file mode 100644 index c0d5be7..0000000 --- a/docs/common.md +++ /dev/null @@ -1,22 +0,0 @@ -## errors - -errors will typically be created and propogated using luaI_error (in c) but will always retain a common style (unless mentioned otherwise) - -it will return 3 values, in order - -* nil (just always a nil value first, useful to do a quick check for errors on functions with a return value) -* string (an error message) -* integer (an error code) - -similarily, when luaI_assert is called, the string will be the expression and the integer will be -1 - -## stream - -this is a generic function used in many places. - -stream:read(?bytes) -stream:file(filename, ?bytes, ?mode) - -bytes is an optional value allowing you to select how many bytes at maximum to read. this value can be ignored or adjusted by the function, and if so, it will be noted in the docs (default is nil, and will read as much as possible) - -mode is the mode the file will be opened with (defaults to "w") diff --git a/docs/crypto.md b/docs/crypto.md index c55e6ed..9f785af 100644 --- a/docs/crypto.md +++ b/docs/crypto.md @@ -1,5 +1,7 @@ # crypto +> out of date! + ## hashing \* is optional @@ -1,5 +1,7 @@ # io +> out of date!! + ## common ### pprint diff --git a/docs/math.md b/docs/math.md index 0a84a8a..4bc1743 100644 --- a/docs/math.md +++ b/docs/math.md @@ -1,5 +1,7 @@ # math +> out of date!! + ## common ### lcm diff --git a/docs/readme.md b/docs/readme.md index 9436ba0..83c02e5 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,4 +1,7 @@ # lullaby (llby)
+
+> all files besides this and the content of net/ are out of date! ill be working on them later
+
(name subject to change)
with the library in the same directory [(or one of the other valid search locations)](https://www.lua.org/pil/8.1.html)
@@ -49,6 +52,19 @@ the number of bytes can be selected, the function will return an amount close to some streams may not support the bytes param, and may just ignore it. if it is ignored or not given it will always read the entire stream
+### errors
+
+errors will typically be created and propogated using luaI_error (in c) but will always retain a common style (unless mentioned otherwise)
+
+it will return 3 values, in order
+
+* nil (just always a nil value first, useful to do a quick check for errors on functions with a return value)
+* string (an error message)
+* integer (an error code)
+
+similarily, when luaI_assert is called, the string will be the expression and the integer will be -1
+
+
---
## big changes
diff --git a/docs/table.md b/docs/table.md index e58dd54..9e23332 100644 --- a/docs/table.md +++ b/docs/table.md @@ -1,5 +1,7 @@ # table (tables and sorting) +> out of date!! + ## sorting |name|accepted types|type of sorting|order| diff --git a/docs/thread.md b/docs/thread.md index 62e31bf..aff9aab 100644 --- a/docs/thread.md +++ b/docs/thread.md @@ -1,5 +1,7 @@ # threads **
+> out of date!!
+
## buffer
'takes 'anything'
|