Skip to content

Commit

Permalink
errgroup: add reference to sync.WaitGroup
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-by: Carlos Amedee <[email protected]>
Auto-Submit: Bryan Mills <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
  • Loading branch information
dolmen authored and gopherbot committed Dec 7, 2023
1 parent 10739b0 commit 59c1ca1
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions errgroup/errgroup.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down

0 comments on commit 59c1ca1

Please sign in to comment.