Skip to content

Reopen #345 : unpackb documentation isn't clear #634

Open
@massimosala

Description

@massimosala

Last version, using unpackb:

unpackb() got an unexpected keyword argument 'max_buffer_size'

From the docs:

msgpack.unpackb
See Unpacker for options.

The reader follow the docs and goes to read Unpacker ...

max_str_len, max_bin_len : Deprecated, use max_buffer_size instead

Yes, max_buffer_size doesn't exist in the unpackb declaration.
However, the documentation is confusing.

Solution

unpack should have its own argument description, without referring to another function with a different signature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions