From 70491a81113e7003e314451f3e3cf134c4d41dd7 Mon Sep 17 00:00:00 2001
From: Sean Liao <sean@liao.dev>
Date: Fri, 29 Dec 2023 20:20:03 +0000
Subject: [PATCH] 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>
---
 src/maps/maps.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/maps/maps.go b/src/maps/maps.go
index c92106710d..b712dd3fe8 100644
--- 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 (
-- 
2.48.1