From: David Bendory <bendory@users.noreply.github.com>
Date: Fri, 17 Mar 2023 14:04:01 +0000 (+0000)
Subject: errors: clarify Join documentation
X-Git-Tag: go1.21rc1~1229
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=f53a95fe393b0a23592a54cf83e3d25cfa4bdbdb;p=gostls13.git

errors: clarify Join documentation

The previous documentation used a double-negative in describing Join behavior; this use of language could be confusing.

This update removes the double-negative.

Change-Id: If13e88682e865314a556e7d381143a97fa5486d9
GitHub-Last-Rev: 92b3f88a5d49229e71adafcfa7b1d01dcb7646f3
GitHub-Pull-Request: golang/go#59082
Reviewed-on: https://go-review.googlesource.com/c/go/+/477095
Auto-Submit: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Damien Neil <dneil@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: Ian Lance Taylor <iant@google.com>
---

diff --git a/src/errors/join.go b/src/errors/join.go
index dc5a716aa6..329082a5e3 100644
--- a/src/errors/join.go
+++ b/src/errors/join.go
@@ -6,7 +6,7 @@ package errors
 
 // Join returns an error that wraps the given errors.
 // Any nil error values are discarded.
-// Join returns nil if errs contains no non-nil values.
+// Join returns nil if every value in errs is nil.
 // The error formats as the concatenation of the strings obtained
 // by calling the Error method of each element of errs, with a newline
 // between each string.