Skip to content

Ambiguous documentation #1295

Closed
Closed
@neimad1985

Description

@neimad1985

Hi,

First thanks for the great lib, I'm having fun using it !

A question about the documentation please.
In the documentation for the KafkaConsumer, there is the parameter fetch_max_bytes (fetch_min_bytes as well, and others of the same kind..)
You say that it's default value is 50 Mb.
The problem is that the name of the function is about bytes and Mb is about bits (and MB is about bytes).
The question is : what is the real value/amount of data ? Because this leads to an 8 factor error.
If we talk about bits, then the function should have been named fetch_max_bits.
If we talk about bytes, the documentation should be patched to indicate 50 MB.

Same thing for all other functions of the same kind.

Thanks in advance for the tip and go on with the great work :)

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions