From b41931bf67136f50cf8fb11442a7e614da00a0b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolai=20S=C3=B8borg?=
 <NicolaiSoeborg@users.noreply.github.com>
Date: Tue, 7 Apr 2020 15:14:25 +0200
Subject: [PATCH] json doc: Note about Option and reserved keywords (#13895)

---
 lib/pure/json.nim | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/pure/json.nim b/lib/pure/json.nim
index beb3f7049b..7921c0c05f 100644
--- a/lib/pure/json.nim
+++ b/lib/pure/json.nim
@@ -102,16 +102,23 @@
 ## In addition to reading dynamic data, Nim can also unmarshal JSON directly
 ## into a type with the ``to`` macro.
 ##
+## Note: Use `Option <options.html#Option>`_ for keys sometimes missing in json
+## responses, and backticks around keys with a reserved keyword as name.
+##
 ## .. code-block:: Nim
 ##   import json
+##   import options
 ##
 ##   type
 ##     User = object
 ##       name: string
 ##       age: int
+##       `type`: Option[string]
 ##
 ##   let userJson = parseJson("""{ "name": "Nim", "age": 12 }""")
 ##   let user = to(userJson, User)
+##   if user.`type`.isSome():
+##     assert user.`type`.get() != "robot"
 ##
 ## Creating JSON
 ## =============