Skip to content

KAFKA-3044: Re-word consumer.poll behaviour #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
praveend wants to merge 2 commits into from
Closed

KAFKA-3044: Re-word consumer.poll behaviour #751

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
331a5ec
Doc change as per KAFKA-3044
praveend Jan 10, 2016
5e2f89d
Grammar changes
praveend Jan 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,8 +798,9 @@ public void assign(List<TopicPartition> partitions) {
* offset for the subscribed list of partitions
*
*
* @param timeout The time, in milliseconds, spent waiting in poll if data is not available. If 0, returns
* immediately with any records that are available now. Must not be negative.
* @param timeout The time, in milliseconds, spent waiting in poll if data is not available in buffer.

@ewencp ewencp Jan 11, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: missing articles & punctuation in this description. "not available in buffer" -> "not available in the buffer". "available currently in buffer else return empty" -> "available currently in the buffer, else return empty"

@praveend praveend Jan 11, 2016

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ewencp . Corrected!!

* If 0, returns immediately with any records that are available currently in buffer else returns empty.
* Must not be negative.
* @return map of topic to records since the last fetch for the subscribed list of topics and partitions
*
* @throws org.apache.kafka.clients.consumer.InvalidOffsetException if the offset for a partition or set of
Expand Down