Browse Source

Merge pull request #1708 from Kelimion/varint_doc

[varint] Clear up doc.odin.
Jeroen van Rijn 3 years ago
parent
commit
f6fa553572
1 changed files with 14 additions and 13 deletions
  1. 14 13
      core/encoding/varint/doc.odin

+ 14 - 13
core/encoding/varint/doc.odin

@@ -4,24 +4,25 @@
 	Author of this Odin package: Jeroen van Rijn
 	Author of this Odin package: Jeroen van Rijn
 
 
 	Example:
 	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
 package varint