Merge pull request redpanda-data#12 from weeco/enhance-new-client-doc…

…umentation Enhance NewClient documentation
mmaslankaprv · Oct 6, 2020 · 394944a · 394944a
2 parents 3bc9454 + cdf6a66
commit 394944a
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/pkg/kgo/client.go b/pkg/kgo/client.go
@@ -79,7 +79,11 @@ type Client struct {
 }
 
 // NewClient returns a new Kafka client with the given options or an error if
-// the options are invalid.
+// the options are invalid. Connections to brokers are lazily created only when
+// requests are written to them.
+//
+// NewClient also launches a goroutine which periodically updates the cached
+// topic metadata.
 func NewClient(opts ...Opt) (*Client, error) {
 	cfg := defaultCfg()
 	for _, opt := range opts {