Skip to content

fix docstring for read_size #700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
methane merged 1 commit into from
Jun 19, 2026
+3 −2
Merged

fix docstring for read_size #700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ msgpack/*.cpp
/tags
/docs/_build
.cache
uv.lock
2 changes: 1 addition & 1 deletion msgpack/_unpacker.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ cdef class Unpacker:
If specified, unpacker reads serialized data from it and `.feed()` is not usable.

:param int read_size:
Used as `file_like.read(read_size)`. (default: `min(16*1024, max_buffer_size)`)
Used as `file_like.read(read_size)`. Must be equal to or smaller than *max_buffer_size*.

:param bool use_list:
If true, unpack msgpack array to Python list.
Expand Down
2 changes: 1 addition & 1 deletion msgpack/fallback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ class Unpacker:
If specified, unpacker reads serialized data from it and `.feed()` is not usable.

:param int read_size:
Used as `file_like.read(read_size)`. (default: `min(16*1024, max_buffer_size)`)
Used as `file_like.read(read_size)`. Must be equal to or smaller than *max_buffer_size*.

:param bool use_list:
If true, unpack msgpack array to Python list.
Expand Down
Loading