From 3389e695faa9a8aacdbad28638660c3e5bccfb8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@henrietta.com.pl> Date: Fri, 6 Aug 2021 17:45:14 +0200 Subject: [PATCH] docs --- docs/usage.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index 540aa84..06145a5 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -84,6 +84,8 @@ There's also a class available for encoding. Use it like you would a normal Pyth must use the parameter :code:`use_strict_order` in :class:`~minijson.MiniJSONEncoder`. :class:`~minijson.MiniJSONEncoder` will then extract the items from the dictionary, -and sort them before dumping them to binary output. +and sort them before dumping them to binary output. By enabling this feature you guarantee +that identical dicts, serialized by identical Pythons will have the exact same binary representation. + Only then strict order will be guaranteed. Your keys must be comparable anyway. -- GitLab