MINOR: Rephrase Javadoc summary for ConsumerRecord#2290
MINOR: Rephrase Javadoc summary for ConsumerRecord#2290LoneRifle wants to merge 2 commits intoapache:trunkfrom LoneRifle:patch-1
Conversation
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
| * A key/value pair to be received from Kafka. This consists of a topic name and a partition number, from which the | ||
| * record is being received and an offset that points to the record in a Kafka partition. | ||
| * A key/value pair to be received from Kafka. This also consists of a topic name and a partition number from which the | ||
| * record is being received, and an offset that points to the record in a Kafka partition. |
There was a problem hiding this comment.
We should probably mention the timestamp that was added in 0.10.0.0.
There was a problem hiding this comment.
Done, will attempt to squash all commits later once approved.
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): |
|
LGTM (test failures are due to an unrelated known issue) |
| * record is being received and an offset that points to the record in a Kafka partition. | ||
| * A key/value pair to be received from Kafka. This also consists of a topic name and | ||
| * a partition number from which the record is being received, an offset that points | ||
| * to the record in a Kafka partition, and a timestamp as marked by the corresponding ProducerRecord. |
There was a problem hiding this comment.
The timestamp is not necessarily the one in the ProducerRecord (if LogAppendTime is used), so it would be good to clarify that.
The original Javadoc description for `ConsumerRecord` is slightly confusing in that it can be read in a way such that an object is a key value pair received from Kafka, but (only) consists of the metadata associated with the record. This PR makes it clearer that the metadata is _included_ with the record, and moves the comma so that the phrase "topic name and partition number" in the sentence is more closely associated with the phrase "from which the record is being received". Author: LoneRifle <LoneRifle@users.noreply.github.com> Reviewers: Ismael Juma <ismael@juma.me.uk>, Ewen Cheslack-Postava <ewen@confluent.io> Closes apache#2290 from LoneRifle/patch-1
4 participants
The original Javadoc description for
ConsumerRecordis slightly confusing in that it can be read in a way such that an object is a key value pair received from Kafka, but (only) consists of the metadata associated with the record. This PR makes it clearer that the metadata is included with the record, and moves the comma so that the phrase "topic name and partition number" in the sentence is more closely associated with the phrase "from which the record is being received".