Skip to content

Commit

Permalink
Fix incomplete documentation for AIOKafkaConsumer.offset_for_times (a…
Browse files Browse the repository at this point in the history
…io-libs#1068)

Updates the return description to be in line with the behaviour of
the offset_for_times function and the official Kafka documentation.
  • Loading branch information
jzvandenoever authored Oct 31, 2024
1 parent cb2006c commit 64adc84
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion aiokafka/consumer/consumer.py
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,8 @@ async def offsets_for_times(self, timestamps):
Returns:
dict(TopicPartition, OffsetAndTimestamp): mapping from
partition to the timestamp and offset of the first message with
timestamp greater than or equal to the target timestamp.
timestamp greater than or equal to the target timestamp. None will
be returned for the partition if there is no such message.
Raises:
ValueError: If the target timestamp is negative
Expand Down

0 comments on commit 64adc84

Please sign in to comment.