Skip to content

Commit 64adc84

Browse files
Fix incomplete documentation for AIOKafkaConsumer.offset_for_times (#1068)
Updates the return description to be in line with the behaviour of the offset_for_times function and the official Kafka documentation.
1 parent cb2006c commit 64adc84

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

aiokafka/consumer/consumer.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,8 @@ async def offsets_for_times(self, timestamps):
927927
Returns:
928928
dict(TopicPartition, OffsetAndTimestamp): mapping from
929929
partition to the timestamp and offset of the first message with
930-
timestamp greater than or equal to the target timestamp.
930+
timestamp greater than or equal to the target timestamp. None will
931+
be returned for the partition if there is no such message.
931932
932933
Raises:
933934
ValueError: If the target timestamp is negative

0 commit comments

Comments
 (0)