Documentation regarding Message

[DieterDePaepe]

The docs mention that a Message contains a response_code, topic, payload, key (optional) and offset. However, it seems that in practice, response_code, topic and payload are not present.

In addition, in my first exploration of this library, I assumed the consumers to produce messages of type pykafka.common.Message instead of pykafka.protocol.Message, which are better documented. (pykafka.protocol.Message inherits from pykafka.common.Message, so the missing variables listed above apply here as well.) I would suggest also documenting the type of messages returned by the consumers.

PyKafka version: 2.8.0

[emmettbutler]

Thanks, this is a great suggestion @DieterDePaepe. Please feel free to contribute any of the documentation you're referring to via pull request.