summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Widman <jeff@jeffwidman.com>2017-10-16 11:35:39 -0700
committerJeff Widman <jeff@jeffwidman.com>2017-10-16 12:39:23 -0700
commitcd4d01cec81d35b428489360e104658b8e7e720b (patch)
treec511a8936509e5fbb695af37fa136973532bc8a2
parent0d2164431f8245359c417473fd84e7af034f1306 (diff)
downloadkafka-python-cd4d01cec81d35b428489360e104658b8e7e720b.tar.gz
Fix docstring
-rw-r--r--kafka/consumer/group.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py
index cbfd720..9a1cda1 100644
--- a/kafka/consumer/group.py
+++ b/kafka/consumer/group.py
@@ -990,9 +990,10 @@ class KafkaConsumer(six.Iterator):
partition and no offset reset policy is defined.
"""
# Lookup any positions for partitions which are awaiting reset (which may be the
- # case if the user called seekToBeginning or seekToEnd. We do this check first to
- # avoid an unnecessary lookup of committed offsets (which typically occurs when
- # the user is manually assigning partitions and managing their own offsets).
+ # case if the user called :meth:`seek_to_beginning` or :meth:`seek_to_end`. We do
+ # this check first to avoid an unnecessary lookup of committed offsets (which
+ # typically occurs when the user is manually assigning partitions and managing
+ # their own offsets).
self._fetcher.reset_offsets_if_needed(partitions)
if not self._subscription.has_all_fetch_positions():