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 <bcmills@google.com>
Reviewed-by: Carlos Amedee <carlos@golang.org>
Auto-Submit: Bryan Mills <bcmills@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
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 (
