diff options
| author | Will Daly <will@edx.org> | 2015-01-04 12:23:10 -0500 |
|---|---|---|
| committer | Will Daly <will.e.daly@gmail.com> | 2015-01-15 18:01:40 -0500 |
| commit | 01f378328e5383d05d52428b815f992eb2c536cb (patch) | |
| tree | 2d3366ed91b9744efd40d935a460040150c6d4d8 /kafka/context.py | |
| parent | 02c2b469003e2ddcb051dbb4d95977137050c19f (diff) | |
| download | kafka-python-01f378328e5383d05d52428b815f992eb2c536cb.tar.gz | |
Add Sphinx API docs
Diffstat (limited to 'kafka/context.py')
| -rw-r--r-- | kafka/context.py | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/kafka/context.py b/kafka/context.py index 98ed7b3..ade4db8 100644 --- a/kafka/context.py +++ b/kafka/context.py @@ -18,6 +18,8 @@ class OffsetCommitContext(object): Example: + .. code:: python + consumer = SimpleConsumer(client, group, topic, auto_commit=False) consumer.provide_partition_info() consumer.fetch_last_known_offsets() @@ -57,7 +59,10 @@ class OffsetCommitContext(object): In order to know the current partition, it is helpful to initialize the consumer to provide partition info via: + .. code:: python + consumer.provide_partition_info() + """ max_offset = max(offset + 1, self.high_water_mark.get(partition, 0)) |