aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Rijn <Kelimion@users.noreply.github.com>2022-04-13 00:03:58 +0200
committerGitHub <noreply@github.com>2022-04-13 00:03:58 +0200
commitf6fa553572ca0374ad7e664892ae458d54cb30e6 (patch)
treec8a0aeae0afa4698612e15c26129f792509f38c1
parentf92ffe60e75989483397cbe81fb7495d2247404e (diff)
parent8310436350e7d2104c5b94c6f3909f9f517df502 (diff)
Merge pull request #1708 from Kelimion/varint_doc
[varint] Clear up doc.odin.
-rw-r--r--core/encoding/varint/doc.odin27
1 files changed, 14 insertions, 13 deletions
diff --git a/core/encoding/varint/doc.odin b/core/encoding/varint/doc.odin
index dd068b261..5e4708a59 100644
--- a/core/encoding/varint/doc.odin
+++ b/core/encoding/varint/doc.odin
@@ -4,24 +4,25 @@
Author of this Odin package: Jeroen van Rijn
Example:
- ```odin
- import "core:encoding/varint"
- import "core:fmt"
+ ```odin
+ import "core:encoding/varint"
+ import "core:fmt"
- main :: proc() {
- buf: [varint.LEB128_MAX_BYTES]u8
+ main :: proc() {
+ buf: [varint.LEB128_MAX_BYTES]u8
- value := u128(42)
+ value := u128(42)
- encode_size, encode_err := varint.encode_uleb128(buf[:], value)
- assert(encode_size == 1 && encode_err == .None)
+ encode_size, encode_err := varint.encode_uleb128(buf[:], value)
+ assert(encode_size == 1 && encode_err == .None)
- fmt.println(buf[:encode_size])
+ fmt.printf("Encoded as %v\n", buf[:encode_size])
+ decoded_val, decode_size, decode_err := varint.decode_uleb128(buf[:])
- decoded_val, decode_size, decode_err := varint.decode_uleb128(buf[:encode_size])
- assert(decoded_val == value && decode_size == encode_size && decode_err == .None)
- }
- ```
+ assert(decoded_val == value && decode_size == encode_size && decode_err == .None)
+ fmt.printf("Decoded as %v, using %v byte%v\n", decoded_val, decode_size, "" if decode_size == 1 else "s")
+ }
+ ```
*/
package varint \ No newline at end of file