Mention that only UTF-8 encoding is supported in loads()

python-rapidjson · Jan 14, 2018 · ae5017d · ae5017d
1 parent 287d06a
commit ae5017d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -237,4 +237,10 @@ Coercing keys when dumping
   when you load it back in it'll still be a string. We want the dump and load to return
   the exact same objects so we have decided not to do this coercion.
 
+Arbitrary encodings
+  ``json.loads()`` accepts an ``encoding`` kwarg determining the encoding of its input,
+  when that is a ``bytes`` or ``bytearray`` instance. Although ``RapidJSON`` is able to
+  cope with several different encodings, we currently supports only the recommended one,
+  ``UTF-8``.
+
 .. _RapidJSON: http://rapidjson.org/
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -174,6 +174,12 @@ Coercing keys when dumping
   when you load it back in it'll still be a string. We want the dump and load to return
   the exact same objects so we have decided not to do this coercion.
 
+Arbitrary encodings
+  ``json.loads()`` accepts an ``encoding`` kwarg determining the encoding of its input,
+  when that is a ``bytes`` or ``bytearray`` instance. Although ``RapidJSON`` is able to
+  cope with several different encodings, we currently supports only the recommended one,
+  ``UTF-8``.
+
 
 .. _JSON: http://json.org/
 .. _RapidJSON: http://rapidjson.org/