Fix docs examples (#15)

Author: nitely

cbor_serialization.nimble

@@ -45,11 +45,11 @@ task test, "Run all tests":
   for threads in ["--threads:off", "--threads:on"]:
     run threads, "tests/test_all"
 
-task examples, "Build examples":
-  # Build book examples
+task examples, "Run examples":
+  # Run book examples
   for file in listFiles("docs/examples"):
     if file.endsWith(".nim"):
-      build "--threads:on", file
+      run "--threads:on", file
 
 task mdbook, "Install mdbook (requires cargo)":
   exec "cargo install mdbook@0.4.51 mdbook-toc@0.14.2 mdbook-open-on-gh@2.4.3 mdbook-admonish@1.20.0"

docs/examples/getstarted0.nim

@@ -24,7 +24,7 @@ let encoded =
 # Decode the CBOR blob into our Request type
 let decoded = Cbor.decode(encoded, Request)
 
-echo decoded.id
+doAssert decoded.id == 1
 # ANCHOR_END: Decode
 
 # ANCHOR: Errors

docs/examples/getstarted1.nim

@@ -8,7 +8,7 @@ import cbor_serialization
 type CborRpcId = distinct CborBytes
 
 proc readValue*(
-    r: var CborReader, val: var CborRpcId
+    r: var Cbor.Reader, val: var CborRpcId
 ) {.raises: [IOError, CborReaderError].} =
   let ckind = r.parser.cborKind()
   case ckind
@@ -33,8 +33,8 @@ type Request = object
   params: seq[int]
   id: CborRpcId # CBOR blob
 
-let encoded = Cbor.encode((id: Cbor.encode("test").CborRpcId))
+let encoded = Cbor.encode(Request(id: Cbor.encode("test").CborRpcId))
 let decoded = Cbor.decode(encoded, Request)
-echo Cbor.decode(decoded.id.CborBytes.toBytes(), string)
+doAssert Cbor.decode(decoded.id.CborBytes.toBytes(), string) == "test"
 
 # ANCHOR_END: Custom

docs/examples/getstarted2.nim

@@ -54,10 +54,16 @@ CrpcSys.defaultSerialization Request
 
 # ANCHOR: Encode
 let cbor = Cbor.encode(
-  (cborrpc: "2.0", `method`: "subtract", params: [42, 3], id: Cbor.encode(1).CborBytes)
+  Request(
+    cborrpc: "2.0",
+    `method`: "subtract",
+    params: Opt.some(@[42, 3]),
+    id: Opt.some(Cbor.encode(1).CborRpcId),
+  )
 )
 
 let decoded = CrpcSys.decode(cbor, Request)
 echo decoded
-doAssert CrpcSys.encode(decoded) == cbor
 # ANCHOR_END: Encode
+
+doAssert CrpcSys.encode(decoded) == cbor

docs/examples/reference0.nim

@@ -1,7 +1,6 @@
 import cbor_serialization
 
 # ANCHOR: Decode
-let rawCbor = Cbor.encode((name: "localhost", port: 42))
 type
   NimServer = object
     name: string
@@ -15,8 +14,7 @@ type
     name: CborBytes
     port: CborBytes
 
-var conf = defaultCborReaderConf
-conf.nestedDepthLimit = 0
+let rawCbor = Cbor.encode(NimServer(name: "localhost", port: 42))
 
 # decode into native Nim
 let native = Cbor.decode(rawCbor, NimServer)
@@ -51,5 +49,8 @@ let blob = Cbor.encode(native)
 var output = memoryOutput()
 var writer = Cbor.Writer.init(output)
 writer.writeValue(native)
-echo Cbor.decode(output.getOutput(seq[byte]), NimServer)
+let decoded = Cbor.decode(output.getOutput(seq[byte]), NimServer)
+echo decoded
 # ANCHOR_END: Writer
+
+doAssert decoded == native