kafka-python icon indicating copy to clipboard operation
kafka-python copied to clipboard

Enhance docs based on Javadocs?

Open tvoinarovskyi opened this issue 8 years ago • 2 comments

I see people ask a lot of questions here about how to do this or that with kafka-python. Not so long ago I released aiokafka=0.3.0 with an updated consumer and producer documentation. It contains some useful (in my opinion) code snippets, mostly based on Consumer Javadoc. Maybe I could change it to respect kafka-python's way of doing things and people would find more useful information there.

@jeffwidman @dpkp

tvoinarovskyi avatar Aug 30 '17 10:08 tvoinarovskyi

Original Javadoc: https://kafka.apache.org/0110/javadoc/org/apache/kafka/clients/consumer/KafkaConsumer.html https://kafka.apache.org/0110/javadoc/org/apache/kafka/clients/producer/KafkaProducer.html

tvoinarovskyi avatar Aug 30 '17 10:08 tvoinarovskyi

I am 110% in favor of enhancing the docs with more examples... the additional maintenance overhead is minimal.

Maybe I could change it to respect kafka-python's way of doing things and people would find more useful information there.

I'm unclear what you mean by this... do you mean copy the examples into the kafka-python's docs? Sounds fine with me.

jeffwidman avatar Aug 30 '17 19:08 jeffwidman