From 59c1ca1e4661ed4452be4069ceea3c233f4deec1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Olivier=20Mengu=C3=A9?= Date: Sat, 28 Oct 2023 18:17:38 +0200 Subject: [PATCH] errgroup: add reference to sync.WaitGroup Add doc link to sync.WaitGroup in the package documentation. Rationale: The reference to sync.WaitGroup might be obvious to the authors of this package, but it wasn't to me, so despites I had seen this package multiple times I had never made the link to sync.WaitGroup. So when playing with WaitGroup I was missing remembering about errgroup. In hope this will help others as well as my future self. Change-Id: I2c56976958ad9ab94c1596c96fa86c00dd73d2fb Reviewed-on: https://go-review.googlesource.com/c/sync/+/538335 Reviewed-by: Bryan Mills Reviewed-by: Carlos Amedee Auto-Submit: Bryan Mills LUCI-TryBot-Result: Go LUCI --- errgroup/errgroup.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/errgroup/errgroup.go b/errgroup/errgroup.go index b18efb7..948a3ee 100644 --- a/errgroup/errgroup.go +++ b/errgroup/errgroup.go @@ -4,6 +4,9 @@ // Package errgroup provides synchronization, error propagation, and Context // cancelation for groups of goroutines working on subtasks of a common task. +// +// [errgroup.Group] is related to [sync.WaitGroup] but adds handling of tasks +// returning errors. package errgroup import (