Merge pull request #962 from nZac/JSON-Support-doc-update

added a note to the api documentation about JSON_SORT_KEYS. Fixes #922
11 years ago · ccc2de1997
1 changed files with 6 additions and 0 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@ -385,6 +385,12 @@ you are using Flask 0.10 which implies that:
        doSomethingWith({{ user.username|tojson|safe }});
    </script>

+.. 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.
+
 .. autofunction:: jsonify

 .. autofunction:: dumps