Parsely/pykafka

Documentation regarding Message

Open

#917 aperta il 13 feb 2019

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (231 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (1114 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il codice sorgente di pykafka.common.Message e pykafka.protocol.Message per identificare quali attributi sono effettivamente presenti, poi aggiorna la documentazione di conseguenza.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80