Explain the use of WaitGroup in the example test

redis/channel.go

@@ -21,7 +21,7 @@ type channel[E typevent.Event] struct {
 //
 // Redis Pub/Sub is used as the underlying event bus. The events emitted on the channel are passed
 // to all channels subscribed on the same `name` on the same redis server, regardless of the DB
-// they're connected to – see [https://redis.io/docs/interact/pubsub/#database--scoping].
+// they're connected to – see https://redis.io/docs/interact/pubsub/#database--scoping.
 func NewChannel[E typevent.Event](conf *Config, event string) typevent.Channel[E] {
 	return &channel[E]{
 		Config: conf,

redis/config.go

@@ -14,7 +14,7 @@ type Config struct {
 	keyPrefix string
 }
 
-// NewConfig returns a new [config] for a redis channel.
+// NewConfig returns a new [Config] for a redis channel.
 func NewConfig(client *redis.Client, opts ...ConfigOption) *Config {
 	c := &Config{
 		client: client,

redis/example_test.go

@@ -24,9 +24,12 @@ func ExampleNewChannel() {
 	conf := redis.NewConfig(client)
 	channel := redis.NewChannel[event](conf, "CHANNEL_NAME")
 
-	// Register a subscriber for the channel.
+	// The WaitGroup is necessary to make the example test pass. In a real application,
+	// you would likely just let the handler run until its context is canceled.
 	wg := sync.WaitGroup{}
 	wg.Add(1)
+
+	// Register a subscriber for the channel.
 	sub, _ := channel.Subscribe(context.Background(), func(ctx context.Context, ev event) error {
 		defer wg.Done()
 		fmt.Printf("subscriber says: %s\n", ev)
@@ -37,6 +40,6 @@ func ExampleNewChannel() {
 	// Emit an event on the channel.
 	channel.Emit("Hello World!")
 
-	wg.Wait()
+	wg.Wait() // again, just there to statisfy the example test
 	// Output: subscriber says: Hello World!
 }