From 30025c7ea0a53e17a907ad35ffa56b7b7efd99d1 Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Mon, 10 Dec 2012 20:06:00 +0900 Subject: [PATCH] Improve docstring. --- msgpack/_msgpack.pyx | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/msgpack/_msgpack.pyx b/msgpack/_msgpack.pyx index b2b5222..74a4cc4 100644 --- a/msgpack/_msgpack.pyx +++ b/msgpack/_msgpack.pyx @@ -529,8 +529,7 @@ cdef class Unpacker(object): If write_bytes is not None, it will be called with parts of the raw message as it is unpacked. - When there are not enough bytes for unpacking, `unpack()` raises - `OutOfData` Exception. + Raises `OutOfData` when there are no more bytes to unpack. """ return self._unpack(template_construct, write_bytes) @@ -541,8 +540,7 @@ cdef class Unpacker(object): If write_bytes is not None, it will be called with parts of the raw message as it is unpacked. - When there are not enough bytes for unpacking, `unpack()` raises - `OutOfData` Exception. + Raises `OutOfData` when there are no more bytes to unpack. """ return self._unpack(template_skip, write_bytes) @@ -550,8 +548,7 @@ cdef class Unpacker(object): """assuming the next object is an array, return its size n, such that the next n unpack() calls will iterate over its contents. - When there are not enough bytes for unpacking, `unpack()` raises - `OutOfData` Exception. + Raises `OutOfData` when there are no more bytes to unpack. """ return self._unpack(read_array_header, write_bytes) @@ -559,8 +556,7 @@ cdef class Unpacker(object): """assuming the next object is a map, return its size n, such that the next n * 2 unpack() calls will iterate over its key-value pairs. - When there are not enough bytes for unpacking, `unpack()` raises - `OutOfData` Exception. + Raises `OutOfData` when there are no more bytes to unpack. """ return self._unpack(read_map_header, write_bytes)