summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Widman <jeff@jeffwidman.com>2017-02-28 14:35:53 -0800
committerDana Powers <dana.powers@gmail.com>2017-02-28 14:35:53 -0800
commit6aabe418c398b1e24ca3b34dd628d32cfa8ad5a6 (patch)
tree4cc42acb9414739ebb69f94c7d94a82a18a2bcdd
parent2c23a27483e7b131e8cf3f9c879344cdc497e60e (diff)
downloadkafka-python-6aabe418c398b1e24ca3b34dd628d32cfa8ad5a6.tar.gz
Fix BrokerConnection api_version docs default (#909)
-rw-r--r--kafka/client_async.py8
-rw-r--r--kafka/conn.py7
-rw-r--r--kafka/consumer/group.py9
-rw-r--r--kafka/producer/kafka.py8
4 files changed, 16 insertions, 16 deletions
diff --git a/kafka/client_async.py b/kafka/client_async.py
index 1513f39..85de90a 100644
--- a/kafka/client_async.py
+++ b/kafka/client_async.py
@@ -105,10 +105,10 @@ class KafkaClient(object):
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
default: none.
- api_version (tuple): specify which kafka API version to use. Accepted
- values are: (0, 8, 0), (0, 8, 1), (0, 8, 2), (0, 9), (0, 10)
- If None, KafkaClient will attempt to infer the broker
- version by probing various APIs. Default: None
+ api_version (tuple): Specify which Kafka API version to use. If set
+ to None, KafkaClient will attempt to infer the broker version by
+ probing various APIs. For the full list of supported versions,
+ see KafkaClient.API_VERSIONS. 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 is None
diff --git a/kafka/conn.py b/kafka/conn.py
index f4fbb93..88013f0 100644
--- a/kafka/conn.py
+++ b/kafka/conn.py
@@ -114,10 +114,9 @@ class BrokerConnection(object):
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
default: None.
- api_version (tuple): specify which Kafka API version to use. Accepted
- values are: (0, 8, 0), (0, 8, 1), (0, 8, 2), (0, 9), (0, 10)
- If None, KafkaClient will attempt to infer the broker
- version by probing various APIs. Default: None
+ api_version (tuple): Specify which Kafka API version to use.
+ Accepted values are: (0, 8, 0), (0, 8, 1), (0, 8, 2), (0, 9),
+ (0, 10). Default: (0, 8, 2)
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 is None
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index a300c83..8c2ab2d 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -161,9 +161,9 @@ class KafkaConsumer(six.Iterator):
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
Default: None.
- api_version (tuple): Specify which kafka API version to use.
- If set to None, the client will attempt to infer the broker version
- by probing various APIs. Default: None
+ api_version (tuple): Specify which Kafka API version to use. If set to
+ None, the client will attempt to infer the broker version by probing
+ various APIs. Different versions enable different functionality.
Examples:
(0, 9) enables full group coordination features with automatic
partition assignment and rebalancing,
@@ -173,7 +173,8 @@ class KafkaConsumer(six.Iterator):
partition assignment only,
(0, 8, 0) enables basic functionality but requires manual
partition assignment and offset management.
- For a full list of supported versions, see KafkaClient.API_VERSIONS
+ For the full list of supported versions, see
+ KafkaClient.API_VERSIONS. 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'
diff --git a/kafka/producer/kafka.py b/kafka/producer/kafka.py
index 98d4426..5581f63 100644
--- a/kafka/producer/kafka.py
+++ b/kafka/producer/kafka.py
@@ -224,10 +224,10 @@ class KafkaProducer(object):
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
default: none.
- api_version (tuple): specify which kafka API version to use.
- For a full list of supported versions, see KafkaClient.API_VERSIONS
- If set to None, the client will attempt to infer the broker version
- by probing various APIs. Default: None
+ api_version (tuple): Specify which Kafka API version to use. If set to
+ None, the client will attempt to infer the broker version by probing
+ various APIs. For a full list of supported versions, see
+ KafkaClient.API_VERSIONS. 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'