Merge pull request msgpack#36 from jnothman/patch-3

methane · methane · commit 4d844df492c8 · 2012-12-06T18:11:11.000-08:00
Warn about StopIteration in README
diff --git a/README.rst b/README.rst
@@ -116,6 +116,9 @@ the result, or ignoring it. The latter two methods return the number of elements
 in the upcoming container, so that each element in an array, or key-value pair
 in a map, can be unpacked or skipped individually.
 
+Warning: these methods raise ``StopIteration`` when called at the end of the
+stream. Unless caught, this may silently break an iteration.
+
 Each of these methods may optionally write the packed data it reads to a
 callback function:
 
