summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorINADA Naoki <inada-n@klab.com>2012-12-10 00:35:26 +0900
committerINADA Naoki <inada-n@klab.com>2012-12-10 00:35:26 +0900
commitc7161e9403ce15c4bbea99cb482ea37a74311b45 (patch)
treed8adee33c7b5f2ada6510a3ac14d13c444d3c914
parent219d47503ca982996b03f4396fdd2929c9905356 (diff)
downloadmsgpack-python-c7161e9403ce15c4bbea99cb482ea37a74311b45.tar.gz
Add note for StopIteration => OutOfData.
-rw-r--r--README.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index aa447f3..270b8ff 100644
--- a/README.rst
+++ b/README.rst
@@ -19,9 +19,15 @@ writing MessagePack data.
NOTE for msgpack 0.2.x users
----------------------------
+The msgpack 0.3 have some incompatible changes.
+
The default value of ``use_list`` keyword argument is ``True`` from 0.3.x.
You should pass the argument explicitly for backward compatibility.
+`Unpacker.unpack()` and some unpack methods now raises `OutOfData`
+instead of `StopIteration`.
+`StopIteration` is used for iterator protocol only.
+
HOW TO USE
-----------