raw_decode(): Document 'idx' parameter

1 files changed, 2 insertions, 0 deletions

diff --git a/simplejson/decoder.py b/simplejson/decoder.py
index 714a733..20e04b8 100644
--- a/simplejson/decoder.py
+++ b/simplejson/decoder.py
@@ -413,6 +413,8 @@ class JSONDecoder(object):
         """Decode a JSON document from ``s`` (a ``str`` or ``unicode``
         beginning with a JSON document) and return a 2-tuple of the Python
         representation and the index in ``s`` where the document ended.
+        Optionally, ``idx`` can be used to specify an offset in ``s`` where
+        the JSON document begins.
 
         This can be used to decode a JSON document from a string that may
         have extraneous data at the end.