Skip to content

Commit f1a1702

Browse files
authored
fix docstring for read_size (#700)
fix #697
1 parent 448d43f commit f1a1702

3 files changed

Lines changed: 3 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ msgpack/*.cpp
1515
/tags
1616
/docs/_build
1717
.cache
18+
uv.lock

msgpack/_unpacker.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ cdef class Unpacker:
222222
If specified, unpacker reads serialized data from it and `.feed()` is not usable.
223223
224224
:param int read_size:
225-
Used as `file_like.read(read_size)`. (default: `min(16*1024, max_buffer_size)`)
225+
Used as `file_like.read(read_size)`. Must be equal to or smaller than *max_buffer_size*.
226226
227227
:param bool use_list:
228228
If true, unpack msgpack array to Python list.

msgpack/fallback.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ class Unpacker:
137137
If specified, unpacker reads serialized data from it and `.feed()` is not usable.
138138
139139
:param int read_size:
140-
Used as `file_like.read(read_size)`. (default: `min(16*1024, max_buffer_size)`)
140+
Used as `file_like.read(read_size)`. Must be equal to or smaller than *max_buffer_size*.
141141
142142
:param bool use_list:
143143
If true, unpack msgpack array to Python list.

0 commit comments

Comments
 (0)