maps: document handling of non-reflexive keys

Fixes #63312

Change-Id: I7861bddcd4c6dc208b4449b923eb2785a122aadf
Reviewed-on: https://go-review.googlesource.com/c/go/+/553157
Reviewed-by: Keith Randall <khr@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Reviewed-by: Keith Randall <khr@google.com>
Reviewed-by: qiu laidongfeng2 <2645477756@qq.com>
Auto-Submit: Keith Randall <khr@golang.org>

diff --git a/src/maps/maps.go b/src/maps/maps.go
index c92106710d2e2245987fd67f255184228a2209c2..b712dd3fe8ebaa26a4fac960cfa0eacd0adfa517 100644 (file)
--- a/src/maps/maps.go
+++ b/src/maps/maps.go
@@ -3,6 +3,9 @@
 // license that can be found in the LICENSE file.
 
 // Package maps defines various functions useful with maps of any type.
+//
+// This package does not have any special handling for non-reflexive keys
+// (keys k where k != k), such as floating-point NaNs.
 package maps
 
 import (