Skip to content

Fix incomplete documentation for AIOKafkaConsumer.offset_for_times#1068

Merged
ods merged 1 commit intoaio-libs:masterfrom
jzvandenoever:patch-1
Oct 31, 2024
Merged

Fix incomplete documentation for AIOKafkaConsumer.offset_for_times#1068
ods merged 1 commit intoaio-libs:masterfrom
jzvandenoever:patch-1

Conversation

@jzvandenoever
Copy link
Copy Markdown
Contributor

Changes

Fixes #1067

Updates the return description to be in line with the behaviour of the
offset_for_times function and the official Kafka documentation.

Updates the return description to be in line with the behaviour of
the offset_for_times function and the official Kafka documentation.
@ods
Copy link
Copy Markdown
Collaborator

ods commented Oct 31, 2024

Hi @jzvandenoever, thank you for the contribution! You're right, and we even have a test for such case.

@ods ods merged commit 64adc84 into aio-libs:master Oct 31, 2024
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.11%. Comparing base (cb2006c) to head (e1ce7e2).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1068   +/-   ##
=======================================
  Coverage   95.11%   95.11%           
=======================================
  Files         114      114           
  Lines       16980    16980           
  Branches     1579     1579           
=======================================
  Hits        16150    16150           
  Misses        482      482           
  Partials      348      348           
Flag Coverage Δ
cext 94.92% <ø> (ø)
integration 94.85% <ø> (+0.01%) ⬆️
purepy 94.92% <ø> (ø)
unit 53.09% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consumer.offsets_for_times return type documentation is incomplete.

2 participants