Skip to content

Commit

Permalink
Clarified Assign() contract with channel-based consumer (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
edenhill committed Oct 17, 2019
1 parent ef15071 commit c36e484
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion kafka/kafka.go
Expand Up @@ -48,7 +48,9 @@
// which defaults to the `latest` message) and then call `.Assign(partitions)`
// to start consuming. If you don't need to modify the initial offsets you will
// not need to call `.Assign()`, the client will do so automatically for you if
// you dont.
// you dont, unless you are using the channel-based consumer in which case
// you MUST call `.Assign()` when receiving the `AssignedPartitions` and
// `RevokedPartitions` events.
//
// * As messages are fetched they will be made available on either the
// `.Events` channel or by calling `.Poll()`, look for event type `*kafka.Message`.
Expand Down

0 comments on commit c36e484

Please sign in to comment.