From 6cbe1d48d7717315e41b22a758357ceb24992fcd Mon Sep 17 00:00:00 2001
From: Timothee Cour <timothee.cour2@gmail.com>
Date: Wed, 19 Dec 2018 16:13:25 -0800
Subject: [PATCH] [json] document fact that key ordering is preserved (#10020)

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

diff --git a/lib/pure/json.nim b/lib/pure/json.nim
index 389df40871..010dd8f706 100644
--- a/lib/pure/json.nim
+++ b/lib/pure/json.nim
@@ -134,6 +134,13 @@
 ##    j2["details"] = %* {"age":35, "pi":3.1415}
 ##    echo j2
 
+runnableExamples:
+  ## Note: for JObject, key ordering is preserved, unlike in some languages,
+  ## this is convenient for some use cases. Example:
+  type Foo = object
+    a1, a2, a0, a3, a4: int
+  doAssert $(%* Foo()) == """{"a1":0,"a2":0,"a0":0,"a3":0,"a4":0}"""
+
 import
   hashes, tables, strutils, lexbase, streams, unicode, macros, parsejson