From f5a02b94952e38d35e476acf2bc8b6e0ba2f89fd Mon Sep 17 00:00:00 2001 From: Armin Ronacher Date: Sat, 8 Feb 2014 16:27:26 +0000 Subject: [PATCH] Added a warning about key sorting --- docs/api.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index db550500..c87055d1 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -387,9 +387,12 @@ you are using Flask 0.10 which implies that: .. admonition:: Auto-Sort JSON Keys - The configuration variable ``JSON_SORT_KEYS`` (:ref:`config`) can be set to false to - stop Flask from auto-sorting keys. By default sorting is enabled and - outside of the app context sorting is turned on. + The configuration variable ``JSON_SORT_KEYS`` (:ref:`config`) can be + set to false to stop Flask from auto-sorting keys. By default sorting + is enabled and outside of the app context sorting is turned on. + + Notice that disabling key sorting can cause issues when using content + based HTTP caches and Python's hash randomization feature. .. autofunction:: jsonify