You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by LoneRifle <gi...@git.apache.org> on 2016/12/23 01:34:48 UTC

[GitHub] kafka pull request #2290: MINOR: Rephrase Javadoc summary for ConsumerRecord

GitHub user LoneRifle opened a pull request:

    https://github.com/apache/kafka/pull/2290

    MINOR: Rephrase Javadoc summary for ConsumerRecord

    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".

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/LoneRifle/kafka patch-1

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/kafka/pull/2290.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2290
    
----
commit 00c76af28387e940b8c1c024587d68aa1c25488f
Author: LoneRifle <lo...@users.noreply.github.com>
Date:   2016-12-23T01:29:28Z

    Rephrase Javadoc summary for ConsumerRecord

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] kafka pull request #2290: MINOR: Rephrase Javadoc summary for ConsumerRecord

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/kafka/pull/2290


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---