diff options
| author | Jeff Widman <jeff@jeffwidman.com> | 2019-05-23 23:05:55 -0700 |
|---|---|---|
| committer | Jeff Widman <jeff@jeffwidman.com> | 2019-05-23 23:05:55 -0700 |
| commit | 6140b474da1d73f3318a3d6db2fb316e6572298b (patch) | |
| tree | de9decfa1a983576eb6042ba0f21392d15a6bb14 /kafka | |
| parent | 1a0f2973190e2bb60909bfcd28e5ad8e732e918e (diff) | |
| download | kafka-python-Update-docs-api_version_auto_timeout_ms.tar.gz | |
Update docs for api_version_auto_timeout_msUpdate-docs-api_version_auto_timeout_ms
The docs for `api_version_auto_timeout_ms` mention setting
`api_version='auto'` but that value has been deprecated for years in
favor of `api_version=None`.
Updating the docs for now, and will remove support for `'auto'` in next
major version bump.
Diffstat (limited to 'kafka')
| -rw-r--r-- | kafka/consumer/group.py | 2 | ||||
| -rw-r--r-- | kafka/producer/kafka.py | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py index 6c12767..d504c09 100644 --- a/kafka/consumer/group.py +++ b/kafka/consumer/group.py @@ -209,7 +209,7 @@ class KafkaConsumer(six.Iterator): Default: None api_version_auto_timeout_ms (int): number of milliseconds to throw a timeout exception from the constructor when checking the broker - api version. Only applies if api_version set to 'auto' + api version. Only applies if api_version set to None. connections_max_idle_ms: Close idle connections after the number of milliseconds specified by this config. The broker closes idle connections after connections.max.idle.ms, so this avoids hitting diff --git a/kafka/producer/kafka.py b/kafka/producer/kafka.py index 2a306e0..f6a0603 100644 --- a/kafka/producer/kafka.py +++ b/kafka/producer/kafka.py @@ -255,7 +255,7 @@ class KafkaProducer(object): various APIs. Example: (0, 10, 2). Default: None api_version_auto_timeout_ms (int): number of milliseconds to throw a timeout exception from the constructor when checking the broker - api version. Only applies if api_version set to 'auto' + api version. Only applies if api_version set to None. metric_reporters (list): A list of classes to use as metrics reporters. Implementing the AbstractMetricsReporter interface allows plugging in classes that will be notified of new metric creation. Default: [] |