Parsely/pykafka

Documentation regarding Message

Open

#917 geöffnet am 13. Feb. 2019

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (231 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (1.114 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche den Quellcode von pykafka.common.Message und pykafka.protocol.Message, um zu identifizieren, welche Attribute tatsächlich vorhanden sind, und aktualisiere dann die Dokumentation entsprechend.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80