Parsely/pykafka

Documentation regarding Message

Open

#917 ouverte le 13 févr. 2019

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (231 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (1 114 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez le code source de pykafka.common.Message et pykafka.protocol.Message pour identifier les attributs réellement présents, puis mettez à jour la documentation en conséquence.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80