reflect: clarify Value.Equal behavior for non-comparable values

The current implementation always returns false for non-comparable
values, update the doc to reflect that.

Change-Id: I87f2da408874b0a209c8f51949e3310da15c5904
Reviewed-on: https://go-review.googlesource.com/c/go/+/426195
Reviewed-by: Ian Lance Taylor <iant@google.com>
Reviewed-by: xie cui <523516579@qq.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: hopehook <hopehook@golangcn.org>
Reviewed-by: Heschi Kreinick <heschi@google.com>
Run-TryBot: Cuong Manh Le <cuong.manhle.vn@gmail.com>
Reviewed-by: Cherry Mui <cherryyz@google.com>

diff --git a/src/reflect/value.go b/src/reflect/value.go
index 061545bd4f09acdee614703089dd54e729dbe891..3611a5a66c6694c7e0cae8f742132e25dd4f7b83 100644 (file)
--- a/src/reflect/value.go
+++ b/src/reflect/value.go
@@ -3309,6 +3309,7 @@ func (v Value) Comparable() bool {
 }
 
 // Equal reports true if v is equal to u.
+// For valid values, if either v or u is non-comparable, Equal returns false.
 func (v Value) Equal(u Value) bool {
        if !v.IsValid() || !u.IsValid() {
                return v.IsValid() == u.IsValid()