Parsely/pykafka

Documentation regarding Message

Open

#917 建立於 2019年2月13日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Python (1,114 star) (231 fork)batch import
documentationhelp wanted

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Examine the source code of pykafka.common.Message and pykafka.protocol.Message in the repository's common.py and protocol.py files to verify which attributes are actually present. Update the documentation (likely in the docs directory or readthedocs configuration) to accurately list the fields and clarify that consumers return pykafka.protocol.Message instances. Also check if any attributes like response code, topic, and payload have been removed or renamed.
Documentation regarding Message · Parsely/pykafka#917 | Good First Issue