summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog.rst6
-rw-r--r--README.rst11
-rw-r--r--msgpack/_msgpack.pyx2
3 files changed, 16 insertions, 3 deletions
diff --git a/ChangeLog.rst b/ChangeLog.rst
index 43ee723..279cb81 100644
--- a/ChangeLog.rst
+++ b/ChangeLog.rst
@@ -2,6 +2,12 @@
=====
:release date: in development
+Inconpatible Changes
+--------------------
+
+* Default value of ``use_list`` is ``True`` for now. (It was ``False`` for 0.2.x)
+ You should pass it explicitly for compatibility to 0.2.x.
+
Changes
-------
* Add ``.skip()`` method to ``Unpacker`` (thanks to jnothman)
diff --git a/README.rst b/README.rst
index 58f6cb1..aa447f3 100644
--- a/README.rst
+++ b/README.rst
@@ -3,8 +3,8 @@ MessagePack Python Binding
===========================
:author: INADA Naoki
-:version: 0.2.0
-:date: 2012-06-27
+:version: 0.3.0
+:date: 2012-12-07
.. image:: https://secure.travis-ci.org/msgpack/msgpack-python.png
:target: https://travis-ci.org/#!/msgpack/msgpack-python
@@ -16,6 +16,13 @@ WHAT IT IS
similar data to JSON. This package provides CPython bindings for reading and
writing MessagePack data.
+NOTE for msgpack 0.2.x users
+----------------------------
+
+The default value of ``use_list`` keyword argument is ``True`` from 0.3.x.
+You should pass the argument explicitly for backward compatibility.
+
+
HOW TO USE
-----------
diff --git a/msgpack/_msgpack.pyx b/msgpack/_msgpack.pyx
index 38940f0..5c202fc 100644
--- a/msgpack/_msgpack.pyx
+++ b/msgpack/_msgpack.pyx
@@ -327,7 +327,7 @@ cdef class Unpacker(object):
`read_size` is used as `file_like.read(read_size)`.
(default: min(1024**2, max_buffer_size))
- If `use_list` is true, msgpack list is deserialized to Python list.
+ If `use_list` is true (default), msgpack list is deserialized to Python list.
Otherwise, it is deserialized to Python tuple.
`object_hook` is same to simplejson. If it is not None, it should be callable