From 42e8e518459b82165074a86f522d33b2b4637843 Mon Sep 17 00:00:00 2001 From: Max Jonas Werner Date: Fri, 30 Jun 2017 13:05:22 +0200 Subject: [PATCH] closes #854 clear up doc confusion on producer config --- config.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/config.go b/config.go index 5021c57e9..606a4fabe 100644 --- a/config.go +++ b/config.go @@ -99,7 +99,10 @@ type Config struct { Partitioner PartitionerConstructor // Return specifies what channels will be populated. If they are set to true, - // you must read from the respective channels to prevent deadlock. + // you must read from the respective channels to prevent deadlock. If, + // however, this config is used to create a `SyncProducer`, both must be set + // to true and you shall not read from the channels since the producer does + // this internally. Return struct { // If enabled, successfully delivered messages will be returned on the // Successes channel (default disabled).