confluentinc / confluentinc/confluent-kafka-python

Document Producer.flush default timeout

Open
#755 3 comments 0 reactions 0 assignees View on GitHub
docs priority:high
Dominant language
Python
Stars
509
Forks
964
Avg merge
2d 2h
Merged PRs (30d)
14

Description

Looking at the [Producer.flush](https://docs.confluent.io/current/clients/confluent-kafka-python/index.html#confluent_kafka.Producer.flush) and [Producer.poll](https://docs.confluent.io/current/clients/confluent-kafka-python/index.html#confluent_kafka.Producer.poll) docs it's not clear if the `timeout` parameter is required or optional.

Probably it's optional and there is a default of `-1` for infinite timeout, as in [Producer.list_topics](https://docs.confluent.io/current/clients/confluent-kafka-python/index.html#confluent_kafka.Producer.list_topics)?

Could you please clarify in the docstring?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.