You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by tombentley <gi...@git.apache.org> on 2017/09/27 11:02:54 UTC

[GitHub] kafka pull request #3972: *WIP* MINOR: Add documentation about each of the m...

GitHub user tombentley opened a pull request:

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

    *WIP* MINOR: Add documentation about each of the messages in the protocol

    Following recent refactoring of `Protocol` I suggested to add documentation for the messages to explain the purpose of each message and the participants in the exchange. This is roughly what I was thinking. If this addition is desirable, I will need some help with the actual documentation for some of the request -- If you leave comments on the PR I'll update the doc accordingly.

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

    $ git pull https://github.com/tombentley/kafka MINOR-protocol-doc

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

    https://github.com/apache/kafka/pull/3972.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 #3972
    
----
commit cf7c58ecd72b152f7716b4614e7e16f7695838f5
Author: Tom Bentley <tb...@redhat.com>
Date:   2017-09-27T10:16:25Z

    *WIP* MINOR: Add documentation about each of the messages in the protocol.

----


---