errors: clarify that Join doesn't extend already-joined errors #60215

ItalyPaleAle · 2023-05-16T02:20:19Z

Updates the documentation for Join to explain that it does not append to an existing joinError (i.e. the result of calling Join), and if one of the errors is a joinError, it will be wrapped again. Fixes #60209

It also adds a test to provide an example of said behavior, as well as formalizing it in the API's contract.

Updates the documentation for Join to explain that it does not append to an existing joinError (i.e. the result of calling Join), and if one of the errors is a joinError, it will be wrapped again. See golang#60209 It also adds a test to provide an example of said behavior, as well as formalizing it in the API's contract.

google-cla · 2023-05-16T02:20:22Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

ItalyPaleAle · 2023-05-16T02:22:04Z

The goal of this PR is to explain that patterns such as this one are not supported:

// Assume that errCh is populated by a separate goroutine
errCh := make(chan error, 3)
errCh<-errors.New("err1")
errCh<-errors.New("err2")
errCh<-nil

var err error
for i := 0; i < 3; i++ {
	err = errors.Join(err, <-errCh)
}

gopherbot · 2023-05-16T02:26:24Z

This PR (HEAD: 67d1190) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/go/+/495076 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

gopherbot · 2023-05-16T02:32:10Z

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.